diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index b55dc6fd95e..4f9b0694f8a 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@
Last Updated: April 7, 2011
+Last Updated: April 14, 2011
@@ -981,7 +981,11 @@ include/tools/ |-- Makefile.host +|-- README.txt |-- configure.sh +|-- cfgparser.c +|-- cfgparser.h +|-- define.sh |-- incdir.sh |-- indent.sh |-- link.sh @@ -990,11 +994,19 @@ tools/ |-- mkimage.sh |-- mknulldeps.sh |-- mkromfsimg.sh +|-- mksyscall.c +|-- mkversion.c |-- unlink.sh +|-- version.sh |-- winlink.sh -`-- zipme +`-- zipme.sh+
+ Refer to the README file in the tools directory for more information about the individual files.
+ Some of these tools are discussed below as well in the discussion of configuring and building NuttX.
+
The top-level Makefile in the ${TOPDIR} directory contains all of the top-level control
@@ -1105,13 +1117,58 @@ netutils/
And if configs/<board-name>/[<config-dir>/appconfig
exists and your application directory is not in the standard loction (
cd tools ./configure.sh -a <app-dir> <board-name>[/<config-dir>]+
+ Version Files.
+ The NuttX build expects to find a version file located in the top-level NuttX build directory.
+ That version file is called .version.
+ The correct version file is installed in each versioned NuttX released.
+ However, if you are working from an SVN snapshot, then there will be no version file.
+ If there is no version file, the top-level Makefile will create a dummy .version file on the first make.
+ This dummy version file will contain all zeroes for version information.
+ If that is not what you want, they you should run the version.sh script to create a better .version file.
+
+ You can get help information from the version.sh script using the -h option.
+ For example:
+
+$ tools/version.sh -h +tools/version.sh is a tool for generation of proper version files for the NuttX build + +USAGE: tools/version.sh [-d|-h] [-b build] -v <major.minor> <outfile-path> + +Where: + -d + Enable script debug + -h + show this help message and exit + -v <major.minor> + The NuttX version number expressed a major and minor number separated + by a period + <outfile-path> + The full path to the version file to be created ++ +
+ As an example, the following command will generate a version file for version 6.1 using the current SVN revision number: +
++tools/version.h -v 6.1 .version ++ +
+ The .version file is also used during the build process to create a C header file at include/nuttx/version.h that contains the same version information.
+ That version file may be used by your C applications for, as an example, reporting version information.
+
Additional Configuration Steps.
The remainder of configuration steps will be performed by ${TOPDIR}/Makefile
@@ -1154,7 +1211,8 @@ The system can be re-made subsequently by just typing make.
These additional steps include:
include/nuttx/config. using the ${TOPDIR}/.config file.
+ include/nuttx/config.h using the ${TOPDIR}/.config file.
+ include/nuttx/version.h using the ${TOPDIR}/.version file.
${TOPDIR}/arch/<arch-name>/include at ${TOPDIR}/include/arch.
${TOPDIR}/configs/<board-name>/include at ${TOPDIR}/include/arch/board.
${TOPDIR}/configs/<board-name>/src at ${TOPDIR}/arch/<arch-name>/src/board