This is an automated email from the ASF dual-hosted git repository.
xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new 73214965b8 Documentation/kconfiglib: update document to support
kconfiglib
73214965b8 is described below
commit 73214965b868cd9d7fe0c45a9d655bf6927477cc
Author: chao an <[email protected]>
AuthorDate: Mon Feb 20 12:23:04 2023 +0800
Documentation/kconfiglib: update document to support kconfiglib
Signed-off-by: chao an <[email protected]>
---
Documentation/quickstart/install.rst | 16 ++++++++++++++++
README.md | 18 ++++++++++++++++++
2 files changed, 34 insertions(+)
diff --git a/Documentation/quickstart/install.rst
b/Documentation/quickstart/install.rst
index a2ca57585c..e587134661 100644
--- a/Documentation/quickstart/install.rst
+++ b/Documentation/quickstart/install.rst
@@ -81,6 +81,22 @@ NuttX configuration system uses `KConfig
<https://www.kernel.org/doc/Documentati
$ make
$ make install
+NuttX also supports `kconfiglib <https://github.com/ulfalizer/Kconfiglib>` by
default, which is a Kconfig tool implemented in Python 2/3. Compared with
kconfig-frontends, kconfiglib provides NuttX with the possibility of
multi-platform support(configure NuttX in Winodws native/Visual Studio), and
also kconfiglib has a stronger Kconfig syntax check, this will help developers
to avoid some Kconfig syntax errors. Install kconfiglib via following command:
+
+ .. tabs::
+ $ pip install kconfiglib
+
+If you are a working on Windows, which also need the support of windows-curses:
+
+ .. tabs::
+ $ pip install windows-curses
+
+.. tip::
+ It should be noted that kconfiglib does not support **modules** attributes.
+
(<https://github.com/ulfalizer/Kconfiglib/blob/master/kconfiglib.py#L3239-L3254>,
+ the community seems to have stopped updating), if the features depends on
+ ``CONFIG_BUILD_LOADABLE``, kconfiglib may not be a good choice.
+
Toolchain
=========
diff --git a/README.md b/README.md
index 9b354da866..616d039c0d 100644
--- a/README.md
+++ b/README.md
@@ -954,6 +954,24 @@ not been converted to use the kconfig-frontends tools!
This will
damage your configuration (see
<https://cwiki.apache.org/confluence/display/NUTTX/Converting+Legacy+Configurations+to+Use+kconfig-mconf>).
+NuttX also supports kconfiglib(https://github.com/ulfalizer/Kconfiglib) by
default,
+which is a Kconfig tool implemented in Python 2/3. Compared with
kconfig-frontends,
+kconfiglib provides NuttX with the possibility of multi-platform
support(configure
+NuttX in Winodws native/Visual Studio), and also kconfiglib has a stronger
Kconfig
+syntax check, this will help developers to avoid some Kconfig syntax errors.
+Install kconfiglib via following command:
+
+ pip install kconfiglib
+
+If you are a working on Windows, which also need the support of windows-curses:
+
+ pip install windows-curses
+
+**NOTE**: It should be noted that kconfiglib does not support **modules**
attributes.
+(<https://github.com/ulfalizer/Kconfiglib/blob/master/kconfiglib.py#L3239-L3254>,
+the community seems to have stopped updating), if the features depends on
+`CONFIG_BUILD_LOADABLE`, kconfiglib may not be a good choice.
+
How do we tell a new configuration from an old one? See "Incompatibilities
with Older Configurations" below.
