From 1ea0a468496a9e235b71ca5de33c217eccfe8ef5 Mon Sep 17 00:00:00 2001 From: Ulf Magnusson Date: Mon, 11 Jun 2018 12:31:32 +0200 Subject: 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'. --- README.rst | 29 +++++++++++++++++++++-------- 1 file 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 `_ 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: `_ 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** -- cgit v1.2.3