summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorUlf Magnusson <ulfalizer@gmail.com>2018-06-11 12:31:32 +0200
committerGitHub <noreply@github.com>2018-06-11 12:31:32 +0200
commit1ea0a468496a9e235b71ca5de33c217eccfe8ef5 (patch)
tree6475c002aafe4fd4a8e9c60908a7a890572872f0 /README.rst
parent9fba375c65341cc34f198bd2f9f8b516efcc024f (diff)
README: Mention environment variable expansion in README
Also move the description of the Kconfig extensions out of 'Other features' and into a separate section under 'Library features'.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst29
1 files changed, 21 insertions, 8 deletions
diff --git a/README.rst b/README.rst
index dc25048..36bb38b 100644
--- a/README.rst
+++ b/README.rst
@@ -7,7 +7,7 @@ Overview
Kconfiglib is a `Kconfig
<https://www.kernel.org/doc/Documentation/kbuild/kconfig-language.txt>`_
implementation in Python 2/3. It started out as a helper library, but now has a
-enough functionality to work well as a standalone Kconfig implementation
+enough functionality to also work well as a standalone Kconfig implementation
(including ``menuconfig`` implementations).
The entire library is contained in `kconfiglib.py
@@ -177,6 +177,26 @@ Kconfiglib can do the following, among other things:
<https://github.com/ulfalizer/Kconfiglib/blob/master/examples/menuconfig_example.py>`_
example.
+Kconfig language extensions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following Kconfig extensions are available:
+
+- A relative ``source`` statement (``rsource``) where Kconfig
+ file paths are specified relative to the directory of
+ the current Kconfig file.
+
+- A globbing ``source`` (``gsource``) that doubles
+ as an include-if-exists function.
+
+- Environment variables are expanded directly in e.g. ``source``
+ and ``mainmenu`` statements, meaning ``option env`` symbols
+ are redundant.
+
+ ``option env`` symbols are still supported for compatibility,
+ with the caveat that they must have the same name as the environment
+ variables they reference. A warning is printed if the names differ.
+
Other features
--------------
@@ -235,13 +255,6 @@ Other features
All warnings point out the location(s) in the ``Kconfig`` files where a
symbol is defined, where applicable.
-
-- **Kconfig extensions**
-
- So far, these include a relative ``source`` statement (``rsource``) where Kconfig
- file paths are specified relative to the directory of
- the current Kconfig file, and a globbing ``source`` (``gsource``) that doubles
- as an include-if-exists function.
- **Unicode support**