This is an automated email from the ASF dual-hosted git repository.
acassis 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 85af043d651 Documentation: add nsh boot command reference
85af043d651 is described below
commit 85af043d65160303d050ea43f34208596ebf4b09
Author: Junbo Zheng <[email protected]>
AuthorDate: Mon Jul 27 13:29:30 2026 +0800
Documentation: add nsh boot command reference
Add boot commands.rst section describing its syntax and behavior,
including relative image path resolution against the NSH
current working directory, and boot command config.rst dependency-table
entry
mapping CONFIG_BOARDCTL_BOOT_IMAGE and CONFIG_NSH_DISABLE_BOOT.
Signed-off-by: Junbo Zheng <[email protected]>
---
Documentation/applications/nsh/commands.rst | 17 +++++++++++++++++
Documentation/applications/nsh/config.rst | 1 +
2 files changed, 18 insertions(+)
diff --git a/Documentation/applications/nsh/commands.rst
b/Documentation/applications/nsh/commands.rst
index 8e4c933db07..f1d80040457 100644
--- a/Documentation/applications/nsh/commands.rst
+++ b/Documentation/applications/nsh/commands.rst
@@ -143,6 +143,23 @@ default gateway.
removing the preceding path segments and (optionally) removing any
trailing ``<suffix>``.
+.. _cmdboot:
+
+``boot`` Boot an Application Image
+==================================
+
+**Command Syntax**::
+
+ boot [<image path> [<header size>]]
+
+**Synopsis**. Boot a new application firmware image by invoking
+``boardctl(BOARDIOC_BOOT_IMAGE)``. The ``<image path>`` may be
+absolute or relative; relative paths are resolved against the NSH
+current working directory, consistent with ``cp``, ``cat``, and
+``rm``. This command depends on ``CONFIG_BOARDCTL_BOOT_IMAGE``; if
+the boot image cannot be started, ``boardctl()`` returns and an
+error is reported.
+
.. _cmdbreak:
``break`` Terminate a Loop
diff --git a/Documentation/applications/nsh/config.rst
b/Documentation/applications/nsh/config.rst
index ce61947209a..d40227f35af 100644
--- a/Documentation/applications/nsh/config.rst
+++ b/Documentation/applications/nsh/config.rst
@@ -35,6 +35,7 @@ Command Depends on Configuration
Can Be Disabl
:ref:`cmdbase64enc` ``CONFIG_NETUTILS_CODECS`` &&
``CONFIG_NSH_DISABLE_BASE64ENC``
``CONFIG_CODECS_BASE64``
:ref:`cmdbasename` .
``CONFIG_NSH_DISABLE_BASENAME``
+:ref:`cmdboot` ``CONFIG_BOARDCTL_BOOT_IMAGE``
``CONFIG_NSH_DISABLE_BOOT``
:ref:`cmdbreak` ! ``CONFIG_NSH_DISABLESCRIPT`` && .
! ``CONFIG_NSH_DISABLE_LOOPS``
:ref:`cmdcat` ``CONFIG_NSH_DISABLE_CAT`` .
