Change references to boards/<board>/<config> to boards/<board>/configs/<config> in comments, Documentation, URLs.

This commit is contained in:
Gregory Nutt
2019-08-05 10:16:02 -06:00
parent e1588f6cc2
commit e12c133a53
26 changed files with 85 additions and 75 deletions
+4 -4
View File
@@ -4203,13 +4203,13 @@ static FAR const struct nx_fontpackage_s *g_fontpackages[] =
<p><b>Building <code>apps/examples/nx</code></b>.
NX testing was performed using <code>apps/examples/nx</code> with the
Linux/Cygwin-based NuttX simulator.
Configuration files for building this test can be found in <code>boards/sim/nx</code>
and <code>boards/sim/nx11</code>.
Configuration files for building this test can be found in <code>boards/sim/configs/nx</code>
and <code>boards/sim/configs/nx11</code>.
There are two alternative configurations for building the simulation:
</p>
<ol>
<li>
The configuration using the configuration file at <code>boards/sim/nx/defconfig</code>.
The configuration using the configuration file at <code>boards/sim/configs/nx/defconfig</code>.
This default configuration exercises the NX logic a 8 BPP but provides no visual feedback.
In this configuration, a very simple, simulated framebuffer driver is used that is
based upon a simple region of memory posing as video memory.
@@ -4224,7 +4224,7 @@ make
</li>
<li>
<p>
The preferred configuration is at <code>boards/sim/nx11/defconfig</code>.
The preferred configuration is at <code>boards/sim/configs/nx11/defconfig</code>.
This configuration extends the test with a simulated framebuffer driver
that uses an X window as a framebuffer.
This is a superior test configuration because the X window appears at your desktop
+17 -12
View File
@@ -315,9 +315,10 @@
| | | | `-- <i>(other board-specific header files)</i>
| | | |-- src/
| | | | `-- <i>(board-specific source files)</i>
| | | |---<i>&lt;config-name&gt;</i>/
| | | | `-- <i>(board configuration-specific source files)</i>
| | | `---<i>(other configuration sub-directories for this board)</i>/
| | | `- configs/
| | | |---<i>&lt;config-name&gt;</i>/
| | | | `-- <i>(board configuration-specific source files)</i>
| | | `---<i>(other configuration sub-directories for this board)</i>/
| | `-- <i>&lt;(other board directories)&gt;</i>/
| |-- crypto
| | |-- Makefile
@@ -812,12 +813,13 @@
|-- src/
| |-- Makefile
| `-- <i>(board-specific source files)</i>
|-- <i>&lt;config1-dir&gt;</i>
| |-- Make.defs
| `-- defconfig
|-- <i>&lt;config2-dir&gt;</i>
| |-- Make.defs
| `-- defconfig
|-- configs/
| |-- <i>&lt;config1-dir&gt;</i>
| | |-- Make.defs (optional)
| | `-- defconfig
| |-- <i>&lt;config2-dir&gt;</i>
| | |-- Make.defs
| | `-- defconfig
| ...
|-- scripts/
| |-- <i>(linker script files)</i>
@@ -850,7 +852,7 @@
</ul>
<h4><a name="boardconfigsubdirs">2.5.2.2 Board Specific Configuration Sub-Directories</a></h4>
<p>
The <code>boards/</code><i>&lt;board-name&gt;</i><code>/</code> sub-directory holds all of the
The <code>boards/</code><i>&lt;board-name&gt;</i><code>/configs</code> sub-directory holds all of the
files that are necessary to configure NuttX for the particular board.
A board may have various different configurations using the common source files.
Each board configuration is described by two files: <code>Make.defs</code> and <code>defconfig</code>.
@@ -1555,8 +1557,8 @@ tools/
This could be done manually as follows:
</p>
<ul>
<li>Copy <code>boards/</code><i>&lt;board-name&gt;</i><code>/[</code><i>&lt;config-dir&gt;</i><code>/]Make.defs</code> to <code>${TOPDIR}/Make.defs</code>,<li>
<li>Copy <code>boards/</code><i>&lt;board-name&gt;</i><code>/[</code><i>&lt;config-dir&gt;</i><code>/]defconfig</code> to <code>${TOPDIR}/.config</code></li>
<li>Copy <code>boards/</code><i>&lt;board-name&gt;</i>/<code>configs/[</code><i>&lt;config-dir&gt;</i><code>/]Make.defs</code> to <code>${TOPDIR}/Make.defs</code> (see NOTE below),</li>
<li>Copy <code>boards/</code><i>&lt;board-name&gt;</i>/<code>configs/[</code><i>&lt;config-dir&gt;</i><code>/]defconfig</code> to <code>${TOPDIR}/.config</code></li>
</ul>
<p>
@@ -1567,6 +1569,9 @@ tools/
&lt;config-dir&gt; is the optional, specific configuration directory for the board.
And &lt;app-dir&gt; is the location of the optional application directory.
</p>
<p>
NOTE: Recall that the <code>Make.defs</code> file may reside in either the <code>boards/</code><i>&lt;board-name&gt;</i>/<code>configs/[</code><i>&lt;config-dir&gt;</i></code> directory or in the <code>boards/</code><i>&lt;board-name&gt;</i>/<code>scripts</code>.
</p>
<p>
<b>Automated Configuration</b>.
There is a script that automates these steps. The following steps will
+12 -14
View File
@@ -96,15 +96,15 @@ nuttx/
| |- ekk-lm3s9b96/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ekk-lm3s9b96/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- ez80f910200kitg/
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200kitg/ostest/README.txt" target="_blank">ostest/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200kitg/configs/ostest/README.txt" target="_blank">configs/ostest/README.txt</a>
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200kitg/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- ez80f910200zco/
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/ostest/README.txt" target="_blank">dhcpd/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/httpd/README.txt" target="_blank">httpd/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/nettest/README.txt" target="_blank">nettest/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/nsh/README.txt" target="_blank">nsh/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/ostest/README.txt" target="_blank">ostest/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/poll/README.txt" target="_blank">poll/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/configs/dhcpd/README.txt" target="_blank">configs/dhcpd/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/configs/httpd/README.txt" target="_blank">configs/httpd/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/configs/nettest/README.txt" target="_blank">configs/nettest/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/configs/nsh/README.txt" target="_blank">configs/nsh/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/configs/ostest/README.txt" target="_blank">configs/ostest/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/configs/poll/README.txt" target="_blank">configs/poll/README.txt</a>
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/ez80f910200zco/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- fire-stm32v2/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/fire-stm32v2/README.txt" target="_blank"><b><i>README.txt</i></b></a>
@@ -125,7 +125,6 @@ nuttx/
| |- gapuino/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/gapuino/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- hymini-stm32v/
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/hymini-stm32v/RIDE/README.txt" target="_blank">RIDE/README.txt</a>
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/hymini-stm32v/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- imxrt1050-evk/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/imxrt1050-evk/README.txt" target="_blank"><b><i>README.txt</i></b></a>
@@ -158,7 +157,7 @@ nuttx/
| |- lpcxpresso-lpc54628/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/lpcxpresso-lpc54628/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- makerlisp/
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/makerlisp/nsh/README.txt" target="_blank">nsh/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/makerlisp/configs/nsh/README.txt" target="_blank">configs/nsh/README.txt</a>
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/makerlisp/README.txt" target="_blank"><b><i>README.txt</i></b></a>\
| |- maple/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/maple/README.txt" target="_blank"><b><i>README.txt</i></b></a>\
@@ -298,7 +297,6 @@ nuttx/
| |- spresense/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/spresense/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- stm3210e-eval/
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/stm3210e-eval/RIDE/README.txt" target="_blank">RIDE/README.txt</a>
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/stm3210e-eval/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- stm3220g-eval/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/stm3220g-eval/README.txt" target="_blank"><b><i>README.txt</i></b></a>
@@ -363,16 +361,16 @@ nuttx/
| |- xmc4500-relax/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/xmc4500-relax/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- z16f2800100zcog/
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z16f2800100zcog/ostest/README.txt" target="_blank">ostest/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z16f2800100zcog/pashello/README.txt" target="_blank">pashello/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z16f2800100zcog/configs/ostest/README.txt" target="_blank">configs/ostest/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z16f2800100zcog/configs/pashello/README.txt" target="_blank">configs/pashello/README.txt</a>
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z16f2800100zcog/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- z80sim/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z80sim/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- z8encore000zco/
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z8encore000zco/ostest/README.txt" target="_blank">ostest/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z8encore000zco/configs/ostest/README.txt" target="_blank">configs/ostest/README.txt</a>
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z8encore000zco/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- z8f64200100kit/
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z8f64200100kit/ostest/README.txt" target="_blank">ostest/README.txt</a>
| | |- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z8f64200100kit/configs/ostest/README.txt" target="_blank">configs/ostest/README.txt</a>
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/z8f64200100kit/README.txt" target="_blank"><b><i>README.txt</i></b></a>
| |- zkit-arm-1769/
| | `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/boards/zkit-arm-1769/README.txt" target="_blank"><b><i>README.txt</i></b></a>