summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2019-10-10 09:08:37 +0200
committerUlf Magnusson <ulfalizer@gmail.com>2019-10-10 10:07:29 +0200
commite016deb4bbfae014ada1808abaeeb30558cac209 (patch)
tree96ac8582ac84224efc3994bfd9e588ae662c6945 /README.rst
parent275ddef8dfdc2b404e172d8bdbbc10e5c68b4843 (diff)
Convert standard_kconfig() to argparse for better feedback
Stuff like this is not the pinnacle of helpful design, and hides that the commands actually have long help texts (that can be viewed with pydoc): $ ./menuconfig.py --help [Errno 2] No such file or directory: '--help' Fix it by converting standard_kconfig() to argparse, and add a 'description' argument to it for the command-specific help text. --help now shows the same help text shown by pydoc, and some other error messages are improved as well. Also fix some copy-paste errors and outdated paths in the help texts for the all*config commands.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 4ff63e9..98049a3 100644
--- a/README.rst
+++ b/README.rst
@@ -280,12 +280,12 @@ For HTML output, add ``-w``:
This will also work after installing Kconfiglib with ``pip(3)``.
-Documentation for the ``menuconfig`` and ``guiconfig`` interfaces can be viewed
-in the same way:
+Documentation for other modules can be viewed in the same way (though a plain
+``--help`` will work when they're run as executables):
.. code:: sh
- $ pydoc3 menuconfig/guiconfig
+ $ pydoc(3) menuconfig/guiconfig/...
A good starting point for learning the library is to read the module docstring
(which you could also just read directly at the beginning of `kconfiglib.py