diff --git a/Documentation/NuttShell.html b/Documentation/NuttShell.html index 87e8592e938..e03aadc7fde 100644 --- a/Documentation/NuttShell.html +++ b/Documentation/NuttShell.html @@ -8,7 +8,7 @@
Last Updated: March 1, 2011
+Last Updated: March 7, 2011
Modifying the ROMFS Image.
- The contents of the /etc directory are retained in the file
- examples/nsh/nsh_romfsimg.h. In order to modify the start-up
- behavior, there are three things to study:
+ The contents of the /etc directory are retained in the file examples/nsh/nsh_romfsimg.h OR, if CONFIG_EXAMPLES_NSH_ARCHROMFS is defined, include/arch/board/rcs.template).
+ In order to modify the start-up behavior, there are three things to study:
- mkromfsimg.sh Script.
- The script examples/nsh/mkromfsimg.sh creates nsh_romfsimg.h.
+ tools/mkromfsimg.sh Script.
+ The script tools/mkromfsimg.sh creates nsh_romfsimg.h.
It is not automatically executed. If you want to change the
configuration settings associated with creating and mounting
the /tmp directory, then it will be necessary to re-generate
- this header file using the mkromfsimg.sh script.
+ this header file using the tools/mkromfsimg.sh script.
The behavior of this script depends upon three things:
genromfs tool (available from http://romfs.sourceforge.net).
- - The file
examples/nsh/rcS.template.
+ - The file
examples/nsh/rcS.template
+ (OR, if CONFIG_EXAMPLES_NSH_ARCHROMFS is defined include/arch/board/rcs.template.
rcS.template.
The file examples/nsh/rcS.template contains the general form
- of the rcS file; configurated values are plugged into this
+ of the rcS file; configured values are plugged into this
template file to produce the final rcS file.
+ NOTE:
+ examples/nsh/rcS.template generates the standard, default nsh_romfsimg.h file.
+ If CONFIG_EXAMPLES_NSH_ARCHROMFS is defined in the NuttX configuration file, then a custom, board-specific nsh_romfsimg.h file residing in configs/<board>/include will be used.
+ NOTE when the OS is configured, include/arch/board will be linked to configs/<board>/include.
+
All of the startup-behavior is contained in rcS.template. The
role of mkromfsimg.sh is to (1) apply the specific configuration
@@ -2254,6 +2260,12 @@ nsh>
CONFIG_EXAMPLES_NSH_ARCHROMFSconfigs/<board>/include/nsh_romfsimg.h.
+ CONFIG_EXAMPLES_NSH_ROMFSMOUNTPTCONFIG_EXAMPLES_NSH_NOMACCONFIG_EXAMPLES_NSH_ROMFSDEVNOCONFIG_EXAMPLES_NSH_ROMFSETCCONFIG_EXAMPLES_NSH_ARCHROMFSCONFIG_EXAMPLES_NSH_ROMFSMOUNTPTCONFIG_EXAMPLES_NSH_ROMFSSECTSIZECONFIG_EXAMPLES_NSH_STACKSIZE