This is an automated email from the ASF dual-hosted git repository.
jerpelea 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 4a98cd7b44f Documentation/nxinit: Describe the mount and umount
commands.
4a98cd7b44f is described below
commit 4a98cd7b44fd9bf07bd8cc80e653788264d0e6a4
Author: Marco Casaroli <[email protected]>
AuthorDate: Wed Oct 21 00:44:46 2026 +0200
Documentation/nxinit: Describe the mount and umount commands.
NXInit now has the mount and umount commands. Give their syntax and
an example, and say that a mount line in the NSH syntax still runs
through NSH. Also make the list of built-in commands match the code:
it named chmod, chown, restart, mkdir, copy and write, which NXInit
does not have, and it did not name exec, exec_start, set, unlink and
board_finalinit.
Assisted-by: Claude Code:claude-opus-5-5
Signed-off-by: Marco Casaroli <[email protected]>
---
Documentation/applications/system/nxinit/index.rst | 53 ++++++++++++++++++----
1 file changed, 44 insertions(+), 9 deletions(-)
diff --git a/Documentation/applications/system/nxinit/index.rst
b/Documentation/applications/system/nxinit/index.rst
index 463e70bd3c4..d8e76cb9d1d 100644
--- a/Documentation/applications/system/nxinit/index.rst
+++ b/Documentation/applications/system/nxinit/index.rst
@@ -205,15 +205,50 @@ The commands supported by an action fall into three
types: the built-in
commands of NXInit, the built-in commands of NSH (if NSH is enabled), and
Builtin Apps.
-The following is an explanation of some of NXInit's built-in commands.
-
-- System Operations: mount/umount (mount/unmount file systems), setprop
- (set system properties), chmod/chown (modify file permissions/owner).
-- Service Management: start/stop/restart (start/stop/restart services),
- class_start/class_stop (batch start/stop service categories).
-- File Operations: mkdir (create directories with configurable permissions,
- owner, and encryption settings), copy/write (copy files/write file content).
-- Others: trigger (trigger events).
+These are the built-in commands of NXInit:
+
+- System operations: ``mount``/``umount`` (mount/unmount file systems, see
+ below), ``set`` (set an environment variable), ``setprop`` (set a system
+ property), ``unlink`` (remove a file).
+- Service management: ``start``/``stop`` (start/stop a service),
+ ``exec_start`` (start a service and wait until it exits),
+ ``class_start``/``class_stop`` (start/stop all services of a class).
+- Programs: ``exec -- <program> [<argument>]*`` (run a program and wait until
+ it exits).
+- Others: ``trigger`` (trigger an event), and ``netinit``, ``boot``,
+ ``start_cpu``, ``board_finalinit`` and ``rptun`` when their configuration
+ options are on (``CONFIG_NETUTILS_NETINIT``, ``CONFIG_BOARDCTL_BOOT_IMAGE``,
+ ``CONFIG_BOARDCTL_START_CPU``, ``CONFIG_BOARDCTL_FINALINIT``,
+ ``CONFIG_RPTUN``).
+
+Mounting File Systems
+---------------------
+
+.. code-block::
+
+ mount <type> <device> <dir> [<flag>]* [<options>]
+ mount -t <type> [-o <options>] [<device>] <dir>
+ umount <dir>
+
+``<flag>`` is ``defaults``, ``rw``, ``ro``, ``nosuid``, ``nodev``, ``noexec``,
+``sync``, ``remount``, ``dirsync`` or ``noatime``. In the first form, a last
+argument that is not a flag is the option string of the file system. For a
+file system without a device, ``<device>`` is any name that is not a device,
+for example ``none``. The second form is the one of the NSH command:
+``<options>`` is a comma-separated list of flags and file system options.
+In the pseudo file system, ``<dir>`` does not need to exist: NuttX makes the
+mount point. For example:
+
+.. code-block::
+
+ on boot
+ mount tmpfs none /run
+ mount v9fs none /mnt trans=virtio,tag=host
+ mount -t hostfs -o fs=. /data
+
+``mount`` without arguments runs the NSH command. With
+``CONFIG_DISABLE_MOUNTPOINT``, NXInit has no ``mount`` and ``umount``
+commands.
Compound Commands
------------------
