summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2018-05-01 01:26:39 +0200
committerUlf Magnusson <ulfalizer@gmail.com>2018-05-01 01:28:44 +0200
commit4d0d74dc0a10e63e1372f925d0d2493cba351aa1 (patch)
treeb6d37bdc63592445aefaadbeae11dfde5150e6fb
parentcb75f3c7dea76b7ba0d886f28c83340884d40dfb (diff)
Rename examples/menuconfig.py to menuconfig_example.py
To avoid confusing it with the new terminal menuconfig implementation. Clean up the README a bit at the same time, removing some stuff that's less essential now (e.g. the menuconfig_example.py "screenshot").
-rw-r--r--README.rst42
-rw-r--r--examples/menuconfig_example.py (renamed from examples/menuconfig.py)0
-rwxr-xr-xtests/reltest4
3 files changed, 8 insertions, 38 deletions
diff --git a/README.rst b/README.rst
index 12fed27..070917e 100644
--- a/README.rst
+++ b/README.rst
@@ -75,7 +75,11 @@ Kconfiglib can do the following, among other things:
from symbols depending on preceding symbols. This can be used e.g. to
implement menuconfig-like functionality.
- See the `menuconfig.py <https://github.com/ulfalizer/Kconfiglib/blob/master/examples/menuconfig.py>`_ example.
+ See `menuconfig.py
+ <https://github.com/ulfalizer/Kconfiglib/blob/master/menuconfig.py>`_ and the
+ minimalistic `menuconfig_example.py
+ <https://github.com/ulfalizer/Kconfiglib/blob/master/examples/menuconfig_example.py>`_
+ example.
Here are some other features:
@@ -302,41 +306,7 @@ The `examples/ <https://github.com/ulfalizer/Kconfiglib/blob/master/examples>`_
- `oldconfig.py <https://github.com/ulfalizer/Kconfiglib/blob/master/examples/oldconfig.py>`_ provides ``make oldconfig`` functionality, prompting the user for the values of new symbols to update an old ``.config`` file.
-- `menuconfig.py <https://github.com/ulfalizer/Kconfiglib/blob/master/examples/menuconfig.py>`_ implements a configuration interface that uses notation similar to ``make menuconfig``. It's deliberately kept as simple as possible to demonstrate just the core concepts, and isn't something you'd actually want to use. Here's a screenshot:
-
-.. code-block::
-
- ======== Example Kconfig configuration ========
-
- [*] Enable loadable module support (MODULES)
- Bool and tristate symbols
- [*] Bool symbol (BOOL)
- [ ] Dependent bool symbol (BOOL_DEP)
- < > Dependent tristate symbol (TRI_DEP)
- [ ] First prompt (TWO_MENU_NODES)
- < > Tristate symbol (TRI)
- [ ] Second prompt (TWO_MENU_NODES)
- *** These are selected by TRI_DEP ***
- < > Tristate selected by TRI_DEP (SELECTED_BY_TRI_DEP)
- < > Tristate implied by TRI_DEP (IMPLIED_BY_TRI_DEP)
- String, int, and hex symbols
- (foo) String symbol (STRING)
- (747) Int symbol (INT)
- (0xABC) Hex symbol (HEX)
- Various choices
- -*- Bool choice (BOOL_CHOICE)
- --> Bool choice sym 1 (BOOL_CHOICE_SYM_1)
- Bool choice sym 2 (BOOL_CHOICE_SYM_2)
- {M} Tristate choice (TRI_CHOICE)
- < > Tristate choice sym 1 (TRI_CHOICE_SYM_1)
- < > Tristate choice sym 2 (TRI_CHOICE_SYM_2)
- [ ] Optional bool choice (OPT_BOOL_CHOICE)
-
- Enter a symbol/choice name, "load_config", or "write_config" (or press CTRL+D to exit): BOOL
- Value for BOOL (available: n, y): n
- ...
-
-See the `pymenuconfig <https://github.com/RomaVis/pymenuconfig>`_ project for a real-world `menuconfig` implementation built on top of Kconfiglib.
+- `menuconfig_example.py <https://github.com/ulfalizer/Kconfiglib/blob/master/examples/menuconfig_example.py>`_ implements a configuration interface that uses notation similar to ``make menuconfig``. It's deliberately kept as simple as possible to demonstrate just the core concepts.
Real-world examples
~~~~~~~~~~~~~~~~~~~
diff --git a/examples/menuconfig.py b/examples/menuconfig_example.py
index f026e74..f026e74 100644
--- a/examples/menuconfig.py
+++ b/examples/menuconfig_example.py
diff --git a/tests/reltest b/tests/reltest
index dea0137..cd31711 100755
--- a/tests/reltest
+++ b/tests/reltest
@@ -39,12 +39,12 @@ for py in python2 python3; do
test_script Kconfiglib/examples/print_sym_info.py MODULES
test_script Kconfiglib/examples/print_tree.py
- $py Kconfiglib/examples/menuconfig.py Kconfiglib/examples/Kmenuconfig <<END
+ $py Kconfiglib/examples/menuconfig_example.py Kconfiglib/examples/Kmenuconfig <<END
BOOL
n
END
if (($?)); then
- echo "menuconfig.py failed with $py"
+ echo "menuconfig_example.py failed with $py"
exit 1
fi
done