More changes on name configs/ to boards/ in comments, Documentation, Tools, etc. That is all that I see for now.

This commit is contained in:
Gregory Nutt
2019-08-05 07:24:57 -06:00
parent 615c0ea7ee
commit e0205ff3cc
6 changed files with 23 additions and 23 deletions
+8 -8
View File
@@ -32,7 +32,7 @@
<a href="#DirStructAudio">2.4 nuttx/audio/</a><br> <a href="#DirStructAudio">2.4 nuttx/audio/</a><br>
<a href="#DirStructConfigs">2.5 nuttx/boards/</a> <a href="#DirStructConfigs">2.5 nuttx/boards/</a>
<ul> <ul>
<a href="#configsdirectorystructure">2.5.1 Subdirectory Structure</a><br> <a href="#boardsdirectorystructure">2.5.1 Subdirectory Structure</a><br>
<a href="#summaryofconfigfiles">2.5.2 Summary of Files</a> <a href="#summaryofconfigfiles">2.5.2 Summary of Files</a>
<ul> <ul>
<a href="#boardlogic">2.5.2.1 Board Specific Logic</a><br> <a href="#boardlogic">2.5.2.1 Board Specific Logic</a><br>
@@ -240,7 +240,7 @@
<h1><big><font color="#3c34ec"> <h1><big><font color="#3c34ec">
<i>NuttX RTOS Porting Guide</i> <i>NuttX RTOS Porting Guide</i>
</font></big></h1> </font></big></h1>
<p>Last Updated: May 25, 2019</p> <p>Last Updated: August 5, 2019</p>
</td> </td>
</tr> </tr>
</table> </table>
@@ -309,7 +309,7 @@
| | |-- <i>(binfmt-specific sub-directories)</i>/ | | |-- <i>(binfmt-specific sub-directories)</i>/
| | | `-- <i>(binfmt-specific source files)</i> | | | `-- <i>(binfmt-specific source files)</i>
| | `-- <i>(common binfmt source files)</i> | | `-- <i>(common binfmt source files)</i>
| |-- <a href="#DirStructConfigs">configs</a>/ | |-- <a href="#DirStructConfigs">boards</a>/
| | |-- <i>&lt;board-name&gt;</i>/ | | |-- <i>&lt;board-name&gt;</i>/
| | | |-- include/ | | | |-- include/
| | | | `-- <i>(other board-specific header files)</i> | | | | `-- <i>(other board-specific header files)</i>
@@ -527,7 +527,7 @@
<p> <p>
These board-specific configuration files can be found in the These board-specific configuration files can be found in the
<code>boards/</code><i>&lt;board-name&gt;</i><code>/</code> sub-directories and are discussed <code>boards/</code><i>&lt;board-name&gt;</i><code>/</code> sub-directories and are discussed
in a paragraph <a href="#configsdirectorystructure">below</a>. in a paragraph <a href="#boardsdirectorystructure">below</a>.
</p> </p>
<p> <p>
The directory <code>boards/stm32f4disovery/</code>, as an example, holds board-specific logic for the STM32F4 Discovery board and is selected via the <code>CONFIG_ARCH_BOARD=&quot;stm32f4discovery&quot;</code> configuration setting. The directory <code>boards/stm32f4disovery/</code>, as an example, holds board-specific logic for the STM32F4 Discovery board and is selected via the <code>CONFIG_ARCH_BOARD=&quot;stm32f4discovery&quot;</code> configuration setting.
@@ -791,16 +791,16 @@
The <code>audio/</code> subdirectory contains the NuttX audio sub-system. The <code>audio/</code> subdirectory contains the NuttX audio sub-system.
</p> </p>
<h2>2.5 <a name="DirStructConfigs">nuttx/configs</a></h2> <h2>2.5 <a name="DirStructConfigs">nuttx/boards</a></h2>
<p> <p>
The <code>boards/</code> subdirectory contains configuration data for each board. The <code>boards/</code> subdirectory contains configuration data for each board.
These board-specific configurations plus the architecture-specific configurations in These board-specific configurations plus the architecture-specific configurations in
the <code>arch/</code> subdirectory complete define a customized port of NuttX. the <code>arch/</code> subdirectory complete define a customized port of NuttX.
</p> </p>
<h3><a name="configsdirectorystructure">2.5.1 Subdirectory Structure</a></h3> <h3><a name="boardsdirectorystructure">2.5.1 Subdirectory Structure</a></h3>
<p> <p>
The configs directory contains board specific configuration files. Each board must The <code>boards/</code> directory contains board specific configuration files. Each board must
provide a subdirectory &lt;board-name&gt; under <code>boards/</code> with the following characteristics: provide a subdirectory &lt;board-name&gt; under <code>boards/</code> with the following characteristics:
</p> </p>
<ul><pre> <ul><pre>
@@ -1600,7 +1600,7 @@ Where:
-n selects the Windows host and Windows native (n) environment. -n selects the Windows host and Windows native (n) environment.
Default: Use host setup in the defconfig file Default: Use host setup in the defconfig file
Default Windows: Cygwin Default Windows: Cygwin
&lt;board-name&gt; is the name of the board in the configs directory &lt;board-name&gt; is the name of the board in the <code>boards/</code> directory
&lt;config-name&gt; is the name of the board configuration sub-directory &lt;config-name&gt; is the name of the board configuration sub-directory
&lt;app-dir&gt; is the path to the apps/ directory, relative to the nuttx &lt;app-dir&gt; is the path to the apps/ directory, relative to the nuttx
directory directory
+5 -5
View File
@@ -3,10 +3,10 @@ Board-Specific Configurations
This directory contains the board support for logic for all boards supported This directory contains the board support for logic for all boards supported
by NuttX. This directory is retained in a separate repository and is a Sub- by NuttX. This directory is retained in a separate repository and is a Sub-
Module of NuttX and will appear as nuttx/configs when the NuttX repository Module of NuttX and will appear as nuttx/boards when the NuttX repository
is cloned. is cloned.
The nuttx/configs directory is a part of the internal OS. It should contain The nuttx/boards directory is a part of the internal OS. It should contain
only OS bring-up logic and driver initialization logic. THERE SHOULD BE NO only OS bring-up logic and driver initialization logic. THERE SHOULD BE NO
APPLICATION CALLABLE LOGIC IN THIS DIRECTORY. APPLICATION CALLABLE LOGIC IN THIS DIRECTORY.
@@ -58,7 +58,7 @@ the arch/ subdirectory completely define a customized port of NuttX.
Directory Structure Directory Structure
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
The configs directory contains board specific configuration logic. Each The boards/ directory contains board specific configuration logic. Each
board must provide a subdirectory <board-name> under boards/ with the board must provide a subdirectory <board-name> under boards/ with the
following characteristics: following characteristics:
@@ -200,12 +200,12 @@ boards/c5471evm
NuttX runs on the ARM core and is built with a GNU arm-nuttx-elf toolchain*. NuttX runs on the ARM core and is built with a GNU arm-nuttx-elf toolchain*.
This port is complete and verified. This port is complete and verified.
configs launchxl_cc1310 boards/launchxl_cc1310
Port to the TI SimpleLink CC1310 LaunchPad Evaluation Kit (LAUNCHXL-CC1310) Port to the TI SimpleLink CC1310 LaunchPad Evaluation Kit (LAUNCHXL-CC1310)
featuring the SimpleLinkCC1310 chip. This board features the CC1310F128 featuring the SimpleLinkCC1310 chip. This board features the CC1310F128
part with 128Kb of FLASH and 20Kb of SRAM. part with 128Kb of FLASH and 20Kb of SRAM.
configs launchxl_cc1312r1 boards/launchxl_cc1312r1
Port to the TI SimpleLink CC1312R1 LaunchPad Evaluation Kit (LAUNCHXL-CC1312R1) Port to the TI SimpleLink CC1312R1 LaunchPad Evaluation Kit (LAUNCHXL-CC1312R1)
featuring the SimpleLinkCC1312R1 chip. featuring the SimpleLinkCC1312R1 chip.
+2 -2
View File
@@ -192,8 +192,8 @@ Unlocking FLASH
J-Link>mem8 804000,10 J-Link>mem8 804000,10
00804000 = 39 92 9A F6 80 FF EC AE FF FF FF FF FF FF FF FF 00804000 = 39 92 9A F6 80 FF EC AE FF FF FF FF FF FF FF FF
J-Link>loadfile D:\Spuda\Documents\projects\nuttx\master\nuttx\configs\metro-m4\scripts\nvm.srec J-Link>loadfile D:\Spuda\Documents\projects\nuttx\master\nuttx\boards\metro-m4\scripts\nvm.srec
Downloading file [D:\Spuda\Documents\projects\nuttx\master\nuttx\configs\metro-m4\scripts\nvm.srec]... Downloading file [D:\Spuda\Documents\projects\nuttx\master\nuttx\boards\metro-m4\scripts\nvm.srec]...
J-Link: Flash download: Bank 1 @ 0x00804000: 1 range affected (16 bytes) J-Link: Flash download: Bank 1 @ 0x00804000: 1 range affected (16 bytes)
J-Link: Flash download: Total time needed: 0.089s (Prepare: 0.035s, Compare: 0.011s, Erase: 0.000s, Program: 0.019s, Verify: 0.011s, Restore: 0.011s) J-Link: Flash download: Total time needed: 0.089s (Prepare: 0.035s, Compare: 0.011s, Erase: 0.000s, Program: 0.019s, Verify: 0.011s, Restore: 0.011s)
O.K. O.K.
+2 -2
View File
@@ -805,7 +805,7 @@ refresh.sh
--help --help
Show this help message and exit Show this help message and exit
<board> <board>
The board directory under nuttx/configs The board directory under nuttx/boards
<config> <config>
The board configuration directory under nuttx/boards/<board> The board configuration directory under nuttx/boards/<board>
@@ -944,7 +944,7 @@ testbuild.sh
The first value is the usual configuration description of the form The first value is the usual configuration description of the form
form <board-name>/<configuration-name> and must correspond to a form <board-name>/<configuration-name> and must correspond to a
configuration in the nuttx/configs directory. configuration in the nuttx/boards directory.
The second value is valid name for a toolchain configuration to use The second value is valid name for a toolchain configuration to use
when building the configuration. The set of valid toolchain when building the configuration. The set of valid toolchain
+5 -5
View File
@@ -171,11 +171,11 @@ static void show_usage(const char *progname, int exitcode)
fprintf(stderr, " ..%capps-xx.yy where xx.yy is the NuttX version number.\n", g_delim); fprintf(stderr, " ..%capps-xx.yy where xx.yy is the NuttX version number.\n", g_delim);
fprintf(stderr, " <board-name>:\n"); fprintf(stderr, " <board-name>:\n");
fprintf(stderr, " Identifies the board. This must correspond to a board directory\n"); fprintf(stderr, " Identifies the board. This must correspond to a board directory\n");
fprintf(stderr, " under nuttx%cconfigs%c.\n", g_delim, g_delim); fprintf(stderr, " under nuttx%cboards%c.\n", g_delim, g_delim);
fprintf(stderr, " <config-name>:\n"); fprintf(stderr, " <config-name>:\n");
fprintf(stderr, " Identifies the specific configuration for the selected <board-name>.\n"); fprintf(stderr, " Identifies the specific configuration for the selected <board-name>.\n");
fprintf(stderr, " This must correspond to a sub-directory under the board directory at\n"); fprintf(stderr, " This must correspond to a sub-directory under the board directory at\n");
fprintf(stderr, " under nuttx%cconfigs%c<board-name>%c.\n", g_delim, g_delim, g_delim); fprintf(stderr, " under nuttx%cboards%c<board-name>%c.\n", g_delim, g_delim, g_delim);
fprintf(stderr, " -h:\n"); fprintf(stderr, " -h:\n");
fprintf(stderr, " Prints this message and exits.\n"); fprintf(stderr, " Prints this message and exits.\n");
exit(exitcode); exit(exitcode);
@@ -552,7 +552,7 @@ static void check_configdir(void)
{ {
/* Get the path to the top level configuration directory */ /* Get the path to the top level configuration directory */
snprintf(g_buffer, BUFFER_SIZE, "%s%cconfigs", g_topdir, g_delim); snprintf(g_buffer, BUFFER_SIZE, "%s%cboards", g_topdir, g_delim);
debug("check_configdir: Checking configtop=%s\n", g_buffer); debug("check_configdir: Checking configtop=%s\n", g_buffer);
verify_directory(g_buffer); verify_directory(g_buffer);
@@ -560,7 +560,7 @@ static void check_configdir(void)
/* Get and verify the path to the selected configuration */ /* Get and verify the path to the selected configuration */
snprintf(g_buffer, BUFFER_SIZE, "%s%cconfigs%c%s%c%s", snprintf(g_buffer, BUFFER_SIZE, "%s%cboards%c%s%c%s",
g_topdir, g_delim, g_delim, g_boarddir, g_delim, g_configdir); g_topdir, g_delim, g_delim, g_boarddir, g_delim, g_configdir);
debug("check_configdir: Checking configpath=%s\n", g_buffer); debug("check_configdir: Checking configpath=%s\n", g_buffer);
@@ -573,7 +573,7 @@ static void check_configdir(void)
g_configpath = strdup(g_buffer); g_configpath = strdup(g_buffer);
snprintf(g_buffer, BUFFER_SIZE, "%s%cconfigs%c%s%cscripts", snprintf(g_buffer, BUFFER_SIZE, "%s%cboards%c%s%cscripts",
g_topdir, g_delim, g_delim, g_boarddir, g_delim); g_topdir, g_delim, g_delim, g_boarddir, g_delim);
debug("check_configdir: Checking scriptspath=%s\n", g_buffer); debug("check_configdir: Checking scriptspath=%s\n", g_buffer);
+1 -1
View File
@@ -74,7 +74,7 @@ static char g_delim = '/'; /* Delimiter to use when forming p
#endif #endif
static const char g_archdir[] = "arch"; /* Architecture directory */ static const char g_archdir[] = "arch"; /* Architecture directory */
static const char g_configdir[] = "configs"; /* Board configuration directory */ static const char g_configdir[] = "boards"; /* Board configuration directory */
static char *g_arch[MAX_ARCHITECTURES]; /* List of architecture names */ static char *g_arch[MAX_ARCHITECTURES]; /* List of architecture names */
static int g_narch; /* Number of architecture names */ static int g_narch; /* Number of architecture names */