summaryrefslogtreecommitdiffstats
path: root/nuttx/tools
diff options
context:
space:
mode:
authorpatacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679>2011-04-14 19:17:41 +0000
committerpatacongo <patacongo@7fd9a85b-ad96-42d3-883c-3090e2eb8679>2011-04-14 19:17:41 +0000
commit61d99ee51bb3c6ebfaab8464d84759bcc6b25efb (patch)
treedfdd15e41f6140c6d31674ef3352d4217446ed0d /nuttx/tools
parentae6e6bb741a1762ffca04acee6e8a6c605e25881 (diff)
Documentation update
git-svn-id: https://nuttx.svn.sourceforge.net/svnroot/nuttx/trunk@3505 7fd9a85b-ad96-42d3-883c-3090e2eb8679
Diffstat (limited to 'nuttx/tools')
-rwxr-xr-xnuttx/tools/README.txt30
-rwxr-xr-xnuttx/tools/version.sh3
2 files changed, 26 insertions, 7 deletions
diff --git a/nuttx/tools/README.txt b/nuttx/tools/README.txt
index 76ec3a66fe..14783ae568 100755
--- a/nuttx/tools/README.txt
+++ b/nuttx/tools/README.txt
@@ -17,20 +17,33 @@ configure.sh
target board. See configs/README.txt or Documentation/NuttxPortingGuide.html
for a description of how to configure NuttX with this script.
-mkconfig.c
+mkconfig.c, cfgparser.c, and cfgparser.h
This is C file that is used to build mkconfig program. The mkconfig
program is used during the initial NuttX build.
When you configure NuttX, you will copy a configuration file called .config
- into the top level NuttX directory (See configs/README.txt or
+ in the top level NuttX directory (See configs/README.txt or
Documentation/NuttxPortingGuide.html). The first time you make NuttX,
the top-level makefile will build the mkconfig executable from mkconfig.c
- (using Makefile.mkconfig). The top-level Makefile will then execute the
+ (using Makefile.host). The top-level Makefile will then execute the
mkconfig program to convert the .config file in the top level directory
into include/nuttx/config.h. config.h is a another version of the
NuttX configuration that can be included by C files.
+mkversion.c, cfgparser.c, and cfgparser.h
+
+ This is C file that is used to build mkversion program. The mkversion
+ program is used during the initial NuttX build.
+
+ When you build NuttX there should be a version file called .version in
+ the top level NuttX directory (See Documentation/NuttxPortingGuide.html).
+ The first time you make NuttX, the top-level makefile will build th
+ mkversion executable from mkversion.c (using Makefile.host). The top-
+ level Makefile will then execute the mkversion program to convert the
+ .version file in the top level directory into include/nuttx/version.h.
+ version.h provides version information that can be included by C files.
+
mksyscall.c
This is C file that is used to build mksyscall program. The mksyscall
@@ -56,7 +69,8 @@ mksyscall.c
Makefile.host
This is the makefile that is used to make the mkconfig program from
- the mkconfig.c C file or the mksyscall program from the mksyscall.c file.
+ the mkconfig.c C file, the mkversion program from the mkconfig.c C file,
+ or the mksyscall program from the mksyscall.c file.
mkromfsimg.sh
@@ -80,7 +94,13 @@ mknulldeps.sh
MKDEP = $(TOPDIR)/tools/mknulldeps.sh
The mknulldeps.sh is a stub script that does essentially nothing.
-
+
+define.sh
+
+ Different compilers have different conventions for specifying pre-
+ processor definitions on the compiler command line. This bash
+ script allows the build system to create create command line definitions
+ without concern for the particular compiler in use.
incdir.sh
diff --git a/nuttx/tools/version.sh b/nuttx/tools/version.sh
index e098695a75..7cad7ee032 100755
--- a/nuttx/tools/version.sh
+++ b/nuttx/tools/version.sh
@@ -57,8 +57,7 @@ while [ ! -z "$1" ]; do
VERSION=$1
;;
-h )
- echo "$progname is a tool for flexible generation of include path arguments for a"
- echo "variety of different compilers in a variety of compilation environments"
+ echo "$0 is a tool for generation of proper version files for the NuttX build"
echo ""
echo $USAGE
echo ""