This is an automated email from the ASF dual-hosted git repository.
linguini 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 f2d0d5b45f5 Documentation: Add documentation for NSH_BUILTIN_AS_COMMAND
f2d0d5b45f5 is described below
commit f2d0d5b45f567768566870c906e8d56e1fd6f420
Author: donghaokun <[email protected]>
AuthorDate: Fri Nov 14 16:49:25 2025 +0800
Documentation: Add documentation for NSH_BUILTIN_AS_COMMAND
This patch adds the description for NSH_BUILTIN_AS_COMMAND including its
advantage and disadvantage.
NSH_BUILTIN_AS_COMMAND is an optional configuration in nsh. It allows nsh
builtin apps to run directly like nsh command without creating a thread. This
is done in pull request https://github.com/apache/nuttx-apps/pull/3168
Signed-off-by: Haokun Dong <[email protected]>
---
Documentation/applications/nsh/builtin.rst | 2 ++
Documentation/applications/nsh/config.rst | 7 +++++++
Documentation/applications/nsh/running_apps.rst | 4 +++-
3 files changed, 12 insertions(+), 1 deletion(-)
diff --git a/Documentation/applications/nsh/builtin.rst
b/Documentation/applications/nsh/builtin.rst
index 6c64425b33d..1ea431bc2ec 100644
--- a/Documentation/applications/nsh/builtin.rst
+++ b/Documentation/applications/nsh/builtin.rst
@@ -16,6 +16,8 @@ Built-in application support is enabled with these
configuration option:
- ``CONFIG_BUILTIN``: Enable NuttX support for builtin applications.
- ``CONFIG_NSH_BUILTIN_APPS``: Enable NSH support for builtin
applications.
+ - ``CONFIG_NSH_BUILTIN_AS_COMMAND``: Enable NSH run builtin applications
+ directly without creating a separate thread (optional).
When these configuration options are set, you will also be able to see
the built-in applications if you enter "nsh> help". They will appear at
diff --git a/Documentation/applications/nsh/config.rst
b/Documentation/applications/nsh/config.rst
index 7057309b41c..e28027797cc 100644
--- a/Documentation/applications/nsh/config.rst
+++ b/Documentation/applications/nsh/config.rst
@@ -193,6 +193,13 @@ Configuration Description
more information). This required
``CONFIG_BUILTIN`` to enable
NuttX support for "builtin" applications.
+ ``CONFIG_NSH_BUILTIN_AS_COMMAND`` If enabled, then "builtin" applications
will be executed directly
+ from the NSH command line without
creating a separate thread. The
+ advantage is simpler and faster
execution. The disadvantage is that
+ background execution is not supported.
This required ``CONFIG_BUILTIN``
+ and ``CONFIG_NSH_BUILTIN_APPS`` to enable
NuttX support for "builtin"
+ applications.
+
``CONFIG_NSH_FILEIOSIZE`` Size of a static I/O buffer used for file
access (ignored if there
is no file system). Default is 1024.
diff --git a/Documentation/applications/nsh/running_apps.rst
b/Documentation/applications/nsh/running_apps.rst
index ffa8c297e6a..45c9fffa0b0 100644
--- a/Documentation/applications/nsh/running_apps.rst
+++ b/Documentation/applications/nsh/running_apps.rst
@@ -35,7 +35,9 @@ There are currently be three ways to execute applications
from NSH:
This functionality depends on these configuration settings:
* ``CONFIG_BUILTIN=y`` Enables NuttX support for builtin applications, and
- * ``CONFIG_NSH_BUILTIN_APPS=y`` Enables NSH support for builtin
applications
+ * ``CONFIG_NSH_BUILTIN_APPS=y`` Enables NSH support for builtin
applications, and
+ * ``CONFIG_NSH_BUILTIN_AS_COMMAND``: Enable NSH run builtin applications
directly
+ without creating a separate thread (optional).
In additional to other configuration needed by NSH.
