tools/: Change preferred argument of configurations tools to use ':' as the delimiter between <board-name> and <config-name>. This is to emphasize that this is not a path; it is configuration specification.

The legacy '/' delimiter is still supported but not recommend and not advertised.

Squashed commit of the following:

    Update configurations instructions in more README.txt files to show ':' delimiter vs '/' delimiter.
    Update configurations instructions in various README.txt file to show ':' delimiter vs '/' delimiter.
    tools:  Update all configuration-related tools to accept ':' separator between board and configuration name.
This commit is contained in:
Gregory Nutt
2019-08-05 16:53:39 -06:00
parent 0de938a190
commit 721994846c
147 changed files with 266 additions and 236 deletions
+2 -6
View File
@@ -4215,9 +4215,7 @@ static FAR const struct nx_fontpackage_s *g_fontpackages[] =
based upon a simple region of memory posing as video memory.
That default configuration can be built as follows:
<ul><pre>
cd &lt;NuttX-Directory&gt;/tools
./configure sim/nx
cd &lt;NuttX-Directory&gt;
tools/configure.sh sim:nx
make
./nuttx
</pre></ul>
@@ -4232,9 +4230,7 @@ make
This preferred configuration can be built as follows:
</p>
<ul><pre>
cd &lt;NuttX-Directory&gt;/tools
./configure sim/nx11
cd &lt;NuttX-Directory&gt;
tools/configure sim:nx11
make
./nuttx
</pre></ul>
+5 -5
View File
@@ -1488,7 +1488,7 @@ tools/
|-- cfgparser.h
|-- cmpconfig.c
|-- cnvwindeps.c
|-- configure.sh / configure.bat
|-- configure.sh / configure.bat / configure.c
|-- copydir.sh / copydir.bat
|-- define.sh / define.bat
|-- discovery.py
@@ -1578,14 +1578,14 @@ tools/
accomplish the same configuration:
</p>
<ul><pre>
tools/configure.sh [OPTIONS] <i>&lt;board-name&gt;</i>[/<i>&lt;config-dir&gt;</i>]
tools/configure.sh [OPTIONS] <i>&lt;board-name&gt;</i>:<i>&lt;config-dir&gt;</i>
</pre></ul>
<p>
There is an alternative Windows batch file, <code>configure.bat</code>, that can be used instead of <code>configure.sh</code> in the windows native environment like:
</p>
<ul><pre>
tools\configure.bat <i>&lt;board-name&gt;</i>[\<i>&lt;config-dir&gt;</i>]
tools\configure.bat <i>&lt;board-name&gt;</i>:<i>&lt;config-dir&gt;</i>
</pre></ul>
<p>
See <code>tools/README.txt</code> for more information about these scripts.
@@ -1594,7 +1594,7 @@ tools/
<ul><pre>
$ tools/configure.sh -h
USAGE: tools/configure.sh [-d] [-l|m|c|u|g|n] [-a &lt;app-dir&gt;] &lt;board-name&gt;/&lt;config-name&gt;
USAGE: tools/configure.sh [-d] [-l|m|c|u|g|n] [-a &lt;app-dir&gt;] &lt;board-name&gt;:&lt;config-name&gt;
Where:
-l selects the Linux (l) host environment.
@@ -1616,7 +1616,7 @@ Where:
then you should also specify the location of the application directory on the command line like:
</p>
<ul><pre>
tools/configure.sh -a &lt;app-dir&gt; <i>&lt;board-name&gt;</i>[/<i>&lt;config-dir&gt;</i>]
tools/configure.sh -a &lt;app-dir&gt; <i>&lt;board-name&gt;</i>:<i>&lt;config-dir&gt;</i>
</pre></ul>
<p>
+5 -5
View File
@@ -691,12 +691,12 @@ Instantiating "Canned" Configurations
There is one tool for use with any Bash-like shell that does configuration
steps. It is used as follows:
tools/configure.sh <board-name>/<config-dir>
tools/configure.sh <board-name>:<config-dir>
There is an alternative Windows batch file that can be used in the windows
native environment like:
tools\configure.bat <board-name>\<config-dir>
tools\configure.bat <board-name>:<config-dir>
And, to make sure that other platforms are supported, there is also a
C program at tools/configure.c that can be compiled to establish the
@@ -939,7 +939,7 @@ Make Sure that You are on the Right Platform
configurations. For example, if you are running on Linux and you
configure like this:
tools/configure.sh board/configuration
tools/configure.sh board:configuration
The you can use the following command to both (1) make sure that the
configuration is up to date, AND (2) the configuration is set up
@@ -965,11 +965,11 @@ Make Sure that You are on the Right Platform
platform that you use, and uncompress and refresh the defconfig file all in
one command like:
tools/configure.sh -l board/configuration
tools/configure.sh -l board:configuration
For a Linux host or for a Windows/Cygwin host:
tools/configure.sh -h board/configuration
tools/configure.sh -h board:configuration
Other options are available from the help option built into the
script. You can see all options with:
+1 -1
View File
@@ -59,7 +59,7 @@ Here is a simple test configuration using the NuttX simulator:
1. Install the sim/nsh configuration:
cd tools
./configure.sh sim/nsh
./configure.sh sim:nsh
cd ..
2. Install p-code virtual machine as described above.
+3 -5
View File
@@ -881,14 +881,12 @@ tools/configure.sh
There is a script that automates these steps. The following steps will
accomplish the same configuration:
cd tools
./configure.sh <board-name>/<config-dir>
tools/configure.sh <board-name>:<config-dir>
There is an alternative Windows batch file that can be used in the
windows native enironment like:
cd ${TOPDIR}\tools
configure.bat <board-name>\<config-dir>
tools\configure.bat <board-name>:<config-dir>
See tools/README.txt for more information about these scripts.
@@ -897,7 +895,7 @@ tools/configure.sh
application directory on the command line like:
cd tools
./configure.sh -a <app-dir> <board-name>/<config-dir>
./configure.sh -a <app-dir> <board-name>:<config-dir>
Building Symbol Tables
^^^^^^^^^^^^^^^^^^^^^^
+2 -2
View File
@@ -274,7 +274,7 @@ NuttX buildroot Toolchain
1. You must have already configured Nuttx in <some-dir>/nuttx.
tools/configure.sh amber/<sub-dir>
tools/configure.sh amber:<sub-dir>
NOTE: you also must copy avr-libc header files into the NuttX include
directory with command perhaps like:
@@ -481,7 +481,7 @@ Common Configuration Notes
1. Each Amber Web Server configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh amber/<subdir>
tools/configure.sh amber:<subdir>
Where <subdir> is one of the configuration sub-directories described in
the following paragraph.
+1 -1
View File
@@ -637,7 +637,7 @@ Configurations
Each Arduino Due configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh [OPTIONS] arduino-due/<subdir>
tools/configure.sh [OPTIONS] arduino-due:<subdir>
Where typical options are -l to configure to build on Linux or -c to
configure for Cygwin under Linux. 'tools/configure.sh -h' will show
+1 -1
View File
@@ -48,7 +48,7 @@ Configurations
1. Each Arduino MEGA2560 configuration is maintained in a sub-directory
and can be selected as follow:
tools/configure.sh arduino-mega2560/<subdir>
tools/configure.sh arduino-mega2560:<subdir>
Where <subdir> is one of the configuration sub-directories described in
the following paragraph.
+1 -1
View File
@@ -424,7 +424,7 @@ Common Configuration Notes
1. Each Atmel AVR32DEV configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh avr32dev1/<subdir>
tools/configure.sh avr32dev1:<subdir>
Where <subdir> is one of the configuration sub-directories described in
the following paragraph.
+1 -1
View File
@@ -190,7 +190,7 @@ Configurations
Each B-L475E-IOT01A configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh [-l|c|u|n] /b-l475e-iot01a/<subdir>
tools/configure.sh [-l|c|u|n] /b-l475e-iot01a:<subdir>
Where:
-l selects the Linux (l) host environment. The [-c|u|n] options
+1 -1
View File
@@ -340,7 +340,7 @@ Configurations
Each Bambino-200e configuration is maintained in a sub-directory and can be selected
as follow:
tools/configure.sh bambino-200e/<subdir>
tools/configure.sh bambino-200e:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -169,7 +169,7 @@ Configurations
Each Beaglebone Black configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh [OPTIONS] beaglebone-black/<subdir>
tools/configure.sh [OPTIONS] beaglebone-black:<subdir>
Where [OPTIONS] include -l to configure for a Linux host platform and
-c means to configure for a Windows Cygwin host platform. -h will give
+2 -2
View File
@@ -13,7 +13,7 @@ Toolchain
1. You must have already configured Nuttx in <some-dir>nuttx.
tools/configure.sh c5471evm/<sub-dir>
tools/configure.sh c5471evm:<sub-dir>
2. Download the latest buildroot package into <some-dir>
@@ -122,7 +122,7 @@ Common Configuration Notes
1. Each C5471 configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh c5471evm/<subdir>
tools/configure.sh c5471evm:<subdir>
Where <subdir> is one of the configuration sub-directories described in
the following paragraph.
+1 -1
View File
@@ -160,7 +160,7 @@ Configurations
Each Clicker2 configuration is maintained in a sub-directory and can be
selected as follow:
tools/configure.sh clicker2-stm32/<subdir>
tools/configure.sh clicker2-stm32:<subdir>
Before building, make sure the PATH environment variable includes the
correct path to the directory than holds your toolchain binaries.
+1 -1
View File
@@ -465,7 +465,7 @@ Configurations
Each Cloudctrl configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh shenzhou/<subdir>
tools/configure.sh shenzhou:<subdir>
Where <subdir> is one of the following:
+2 -2
View File
@@ -121,7 +121,7 @@ NuttX Buildroot Toolchain
1. You must have already configured Nuttx in <some-dir>/nuttx.
tools/configure.sh demo9s12nec64/<sub-dir>
tools/configure.sh demo9s12nec64:<sub-dir>
2. Download the latest buildroot package into <some-dir>
@@ -356,7 +356,7 @@ Common Configuration Notes
1. Each Freescale HCS12 configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh demo9s12nec64/<subdir>
tools/configure.sh demo9s12nec64:<subdir>
Where <subdir> is one of the configuration sub-directories described in
the following paragraph.
+1 -1
View File
@@ -647,7 +647,7 @@ Configurations
Each DK-TM4C129X configuration is maintained in a
sub-directory and can be selected as follow:
tools/configure.sh dk-tm4c129x/<subdir>
tools/configure.sh dk-tm4c129x:<subdir>
Where <subdir> is one of the following:
+3 -3
View File
@@ -150,7 +150,7 @@ NuttX buildroot Toolchain
1. You must have already configured Nuttx in <some-dir>/nuttx.
tools/configure.sh ea3131/<sub-dir>
tools/configure.sh ea3131:<sub-dir>
2. Download the latest buildroot package into <some-dir>
@@ -205,7 +205,7 @@ Image Format
Then, to build the NuttX binary ready to load with the bootloader, just
following these steps:
- tools/configure.sh ea3131/nsh # (using the nsh configuration for this example)
- tools/configure.sh ea3131:nsh # (using the nsh configuration for this example)
- cd .. # Set up environment
- make # Make NuttX. This will produce nuttx.bin
- mklpc.sh # Make the bootloader binary (nuttx.lpc)
@@ -591,7 +591,7 @@ Common Configuration Notes
1. Each EA3131 configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh ea3131/<subdir>
tools/configure.sh ea3131:<subdir>
Where <subdir> is one of the configuration sub-directories described in
the following paragraph.
+3 -3
View File
@@ -149,7 +149,7 @@ NuttX buildroot Toolchain
1. You must have already configured Nuttx in <some-dir>/nuttx.
tools/configure.sh ea3152/<sub-dir>
tools/configure.sh ea3152:<sub-dir>
2. Download the latest buildroot package into <some-dir>
@@ -204,7 +204,7 @@ Image Format
Then, to build the NuttX binary ready to load with the bootloader, just
following these steps:
- tools/configure.sh ea3152/ostest # (using the ostest configuration for this example)
- tools/configure.sh ea3152:ostest # (using the ostest configuration for this example)
- cd .. # Set up environment
- make # Make NuttX. This will produce nuttx.bin
- mklpc.sh # Make the bootloader binary (nuttx.lpc)
@@ -394,7 +394,7 @@ Configurations
Each EA3152 configuration is maintained in a sub-directory and can be
selected as follow:
tools/configure.sh ea3152/<subdir>
tools/configure.sh ea3152:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -186,7 +186,7 @@ Common Configuration Notes
1. Each Eagle-100 configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh eagle100/<subdir>
tools/configure.sh eagle100:<subdir>
Where <subdir> is one of the configuration sub-directories described in
the following paragraph.
+1 -1
View File
@@ -231,7 +231,7 @@ CONFIGURATIONS
Each EFM32 Gecko Starter Kit configuration is maintained in a sub-directory
and can be selected as follow:
tools/configure.sh efm32-g8xx-stk/<subdir>
tools/configure.sh efm32-g8xx-stk:<subdir>
If this is a Windows native build, then configure.bat should be used
instead of configure.sh:
+1 -1
View File
@@ -183,7 +183,7 @@ Configurations
Each EFM32 Giant Gecko Starter Kit configuration is maintained in a sub-
directory and can be selected as follow:
tools/configure.sh efm32gg-stk3700/<subdir>
tools/configure.sh efm32gg-stk3700:<subdir>
If this is a Windows native build, then configure.bat should be used
instead of configure.sh:
+1 -1
View File
@@ -190,7 +190,7 @@ Configurations
Each Stellaris EKK-LM3S9b96 Evaluation Kit configuration is maintained in a
sub-directory and can be selected as follow:
tools/configure.sh ekk-lm3s9b96/<subdir>
tools/configure.sh ekk-lm3s9b96:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -577,7 +577,7 @@ Configurations
Each ESP32 core configuration is maintained in sub-directories and
can be selected as follow:
tools/configure.sh esp32-core/<subdir>
tools/configure.sh esp32-core:<subdir>
make oldconfig
Before building, make sure the PATH environment variable includes the
+1 -1
View File
@@ -85,7 +85,7 @@ Variations on the basic ez80f910200kitg configuration are maintained
in subdirectories. To configure any specific configuration, do the
following steps:
tools/configure.sh ez80f910200kitg/<sub-directory>
tools/configure.sh ez80f910200kitg:<sub-directory>
make
Where <sub-directory> is the specific board configuration that you
+1 -1
View File
@@ -89,7 +89,7 @@ Common Configuration Notes
in subdirectories. To configure any specific configuration, do the
following steps:
tools/configure.sh ez80f910200zco/<sub-directory>
tools/configure.sh ez80f910200zco:<sub-directory>
make
Where <sub-directory> is the specific board configuration that you
+1 -1
View File
@@ -560,7 +560,7 @@ Configurations
Each M3 Wildfire configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh fire-stm32v2/<subdir>
tools/configure.sh fire-stm32v2:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -356,7 +356,7 @@ Information Common to All Configurations
1. Each PIC32MZ configuration is maintained in a sub-directory and can be
selected as follow:
tools/configure.sh flipnclick-pic32mz/<subdir>
tools/configure.sh flipnclick-pic32mz:<subdir>
Where typical options are -l to configure to build on Linux or -c to
configure for Cygwin under Linux. 'tools/configure.sh -h' will show
+1 -1
View File
@@ -546,7 +546,7 @@ Configurations
Each Flip&Click SAM3X configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh [OPTIONS] flipnclick-sam3x/<subdir>
tools/configure.sh [OPTIONS] flipnclick-sam3x:<subdir>
Where typical options are -l to configure to build on Linux or -c to
configure for Cygwin under Linux. 'tools/configure.sh -h' will show
+1 -1
View File
@@ -809,7 +809,7 @@ Configurations
Each Freedom K64F configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh freedom-k64f/<subdir>
tools/configure.sh freedom-k64f:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -816,7 +816,7 @@ Configurations
Each Freedom K66F configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh freedom-K66F/<subdir>
tools/configure.sh freedom-K66F:<subdir>
Where <subdir> is one of the following:
+2 -2
View File
@@ -44,7 +44,7 @@ NuttX Buildroot Toolchain
1. You must have already configured Nuttx in <some-dir>/nuttx.
tools/configure.sh freedom-kl25z/<sub-dir>
tools/configure.sh freedom-kl25z:<sub-dir>
2. Download the latest buildroot package into <some-dir>
@@ -274,7 +274,7 @@ Configurations
Each FREEDOM-KL25Z configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh freedom-kl25z/<subdir>
tools/configure.sh freedom-kl25z:<subdir>
If this is a Windows native build, then configure.bat should be used
instead of configure.sh:
+2 -2
View File
@@ -44,7 +44,7 @@ NuttX Buildroot Toolchain
1. You must have already configured Nuttx in <some-dir>/nuttx.
tools/configure.sh freedom-kl26z/<sub-dir>
tools/configure.sh freedom-kl26z:<sub-dir>
2. Download the latest buildroot package into <some-dir>
@@ -252,7 +252,7 @@ Configurations
Each FREEDOM-KL26Z configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh freedom-kl26z/<subdir>
tools/configure.sh freedom-kl26z:<subdir>
If this is a Windows native build, then configure.bat should be used
instead of configure.sh:
+1 -1
View File
@@ -46,7 +46,7 @@ Configurations
Each gapuino configuration is maintained in a sub-directory and can
be selected as follow:
tools/configure.sh gapuino/<subdir>
tools/configure.sh gapuino:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -354,7 +354,7 @@ NOTES:
Each HY-MiniSTM32V configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh hymini-stm32v/<subdir>
tools/configure.sh hymini-stm32v:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -116,7 +116,7 @@ Configurations
Each i.MX RT 10050 configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh [OPTIONS] imxrt1050-evk/<subdir>
tools/configure.sh [OPTIONS] imxrt1050-evk:<subdir>
Where typical options are -l to configure to build on Linux or -c to
configure for Cygwin under Linux. 'tools/configure.sh -h' will show
+1 -1
View File
@@ -134,7 +134,7 @@ Configurations
Each i.MX RT 1060 configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh [OPTIONS] imxrt1060-evk/<subdir>
tools/configure.sh [OPTIONS] imxrt1060-evk:<subdir>
Where typical options are -l to configure to build on Linux or -c to
configure for Cygwin under Linux. 'tools/configure.sh -h' will show
+1 -1
View File
@@ -306,7 +306,7 @@ Configurations
Each KwikStik-K40 configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh kwikstik-k40/<subdir>
tools/configure.sh kwikstik-k40:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -172,7 +172,7 @@ Configurations
Each LaunchXL-TMS50704 configuration is maintained in a sub-directory and
can be selected as follow:
tools/configure.sh launchxl-tms57004/<subdir>
tools/configure.sh launchxl-tms57004:<subdir>
Before building, make sure the PATH environment variable includes the
correct path to the directory than holds your toolchain binaries.
+2 -2
View File
@@ -163,7 +163,7 @@ nsh> wdog
IPL2 is the 2nd boot loader based on NuttX and can be built as follows.
$ make distclean
$ ./tools/configure.sh lc823450-xgevk/ipl2
$ ./tools/configure.sh lc823450-xgevk:ipl2
$ make V=1
$ MakeIPL2 ./nuttx.bin 0 2 0 0 0
$ cp LC8234xx_17S_start_data.boot_bin /tmp/
@@ -172,7 +172,7 @@ To write the IPL2 (LC8234xx_17S_start_data.boot_bin),
firstly build USB configuration image.
$ make distclean
$ ./tools/configure.sh lc823450-xgevk/usb
$ ./tools/configure.sh lc823450-xgevk:usb
$ make V=1
Load the nuttx.bin with openocd + gdb
+1 -1
View File
@@ -272,7 +272,7 @@ Configurations
Each Lincoln 60 configuration is maintained in a sub-directory and can be selected
as follow:
tools/configure.sh lincoln60/<subdir>
tools/configure.sh lincoln60:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -195,7 +195,7 @@ Configurations
Each Stellaris MDL-S2E Reference Design configuration is maintained in a
sub-directory and can be selected as follow:
tools/configure.sh lm3s6432-s2e/<subdir>
tools/configure.sh lm3s6432-s2e:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -333,7 +333,7 @@ Configurations
Each Stellaris LM3S6965 Evaluation Kit configuration is maintained in a
sub-directory and can be selected as follow:
tools/configure.sh lm3s6965-ek/<subdir>
tools/configure.sh lm3s6965-ek:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -253,7 +253,7 @@ Configurations
Each Stellaris LM3S8962 Evaluation Kit configuration is maintained in a
sub-directory and can be selected as follow:
tools/configure.sh lm3s8962-ek/<subdir>
tools/configure.sh lm3s8962-ek:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -462,7 +462,7 @@ Configurations
Each LM4F120 LaunchPad configuration is maintained in a
sub-directory and can be selected as follow:
tools/configure.sh lm4f120-launchpad/<subdir>
tools/configure.sh lm4f120-launchpad:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -591,7 +591,7 @@ Configurations
Each LPC4330-Xplorer configuration is maintained in a sub-directory and can be selected
as follow:
tools/configure.sh lpc4330-xplorer/<subdir>
tools/configure.sh lpc4330-xplorer:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -630,7 +630,7 @@ Configurations
Each LPC4337-ws configuration is maintained in a sub-directory and can be selected
as follow:
tools/configure.sh LPC4337-ws/<subdir>
tools/configure.sh LPC4337-ws:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -627,7 +627,7 @@ Configurations
Each LPC4357-EVB configuration is maintained in a sub-directory and can be selected
as follow:
tools/configure.sh lpc4357-evb/<subdir>
tools/configure.sh lpc4357-evb:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -630,7 +630,7 @@ Configurations
Each LPC4370-Link2 configuration is maintained in a sub-directory and can be selected
as follow:
tools/configure.sh LPC4370-Link2/<subdir>
tools/configure.sh LPC4370-Link2:<subdir>
Where <subdir> is one of the following:
+1 -1
View File
@@ -557,7 +557,7 @@ Configurations
Each LPCXpresso configuration is maintained in a sub-directory and can be
selected as follow:
tools/configure.sh lpcxpresso-lpc1768/<subdir>
tools/configure.sh lpcxpresso-lpc1768:<subdir>
Where <subdir> is one of the following:

Some files were not shown because too many files have changed in this diff Show More