summaryrefslogtreecommitdiff
path: root/nuttx/Documentation
diff options
context:
space:
mode:
authorpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2011-03-20 18:18:19 +0000
committerpatacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>2011-03-20 18:18:19 +0000
commiteafaeb9398216dacb92de69683ccdda6007efb1d (patch)
treee513e4fd791670d9b74d33821682d4059ed73098 /nuttx/Documentation
parentf68c474e8ae9cfa5c9124a6eb92ec06fe2bf40a1 (diff)
downloadpx4-nuttx-eafaeb9398216dacb92de69683ccdda6007efb1d.tar.gz
px4-nuttx-eafaeb9398216dacb92de69683ccdda6007efb1d.tar.bz2
px4-nuttx-eafaeb9398216dacb92de69683ccdda6007efb1d.zip
Move nuttx/examples to apps/examples
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3405 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'nuttx/Documentation')
-rw-r--r--nuttx/Documentation/NXGraphicsSubsystem.html22
-rw-r--r--nuttx/Documentation/NuttX.html24
-rw-r--r--nuttx/Documentation/NuttXNxFlat.html6
-rw-r--r--nuttx/Documentation/NuttxPortingGuide.html174
-rwxr-xr-xnuttx/Documentation/README.html6
-rwxr-xr-xnuttx/Documentation/UsbTrace.html4
6 files changed, 122 insertions, 114 deletions
diff --git a/nuttx/Documentation/NXGraphicsSubsystem.html b/nuttx/Documentation/NXGraphicsSubsystem.html
index ac67c9614..4e6e78054 100644
--- a/nuttx/Documentation/NXGraphicsSubsystem.html
+++ b/nuttx/Documentation/NXGraphicsSubsystem.html
@@ -12,7 +12,7 @@
<h1><big><font color="#3c34ec">
<i>NX Graphics Subsystem</i>
</font></big></h1>
- <p>Last Updated: July 27, 2010</p>
+ <p>Last Updated: March 20, 2010</p>
</td>
</tr>
</table>
@@ -212,7 +212,7 @@
</tr>
<tr>
<td><small>Figure 1.
- This scren shot shows the final frame for the NuttX example at <code>examples/nx</code>
+ This scren shot shows the final frame for the NuttX example at <code>apps/examples/nx</code>
running on the simulated, Linux x86 platform with simulated framebuffer output to
an X window.
This picture shows to framed windows with (blank) toolbars.
@@ -2499,9 +2499,9 @@ int nxf_convert_32bpp(FAR uint32_t *dest, uint16_t height,
<h2>2.6 <a name="samplecode">Sample Code</a></h2>
-<p><b><code>examples/nx</code></b>.
+<p><b><code>apps/examples/nx</code></b>.
No sample code is provided in this document.
- However, an example can be found in the NuttX source tree at <code>examples/nx</code>.
+ However, an example can be found in the NuttX source tree at <code>apps/examples/nx</code>.
That code is intended to test NX.
Since it is test code, it is designed to exercise functionality and does not necessarily
represent best NX coding practices.
@@ -2514,7 +2514,7 @@ int nxf_convert_32bpp(FAR uint32_t *dest, uint16_t height,
be implemented by the NX client code.
</p>
-<p><b>Building <code>examples/nx</code></b>.
+<p><b>Building <code>apps/examples/nx</code></b>.
Testing was performed using the Linux/Cygwin-based NuttX simulator.
Instructions are provided for building that simulation are provided in
<a href="#testcoverage">Appendix C</a> of this document.
@@ -2690,11 +2690,11 @@ int nxf_convert_32bpp(FAR uint32_t *dest, uint16_t height,
</tr>
</table>
-<p><b><code>examples/nx</code></b>.
- The primary test tool for debugging NX resides at <code>examples/nx</code>.
+<p><b><code>apps/examples/nx</code></b>.
+ The primary test tool for debugging NX resides at <code>apps/examples/nx</code>.
</p>
-<p><b>Building <code>examples/nx</code></b>.
- NX testing was performed using <code>examples/nx</code> with the
+<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>configs/sim/nx</code>.
There are two alternative configurations for building the simulation:
@@ -2761,7 +2761,7 @@ make
</p>
<p><b>Test Coverage</b>.
- At present, <code>examples/nx</code>t only exercises a subset of NX;
+ At present, <code>apps/examples/nx</code>t only exercises a subset of NX;
the remainder is essentially untested.
The following table describes the testing performed on each NX API:
</p>
@@ -2938,7 +2938,7 @@ make
</tr>
<tr>
<td align="left" valign="top"><a href="#nxeventnotify"><code>nx_eventnotify()</code></a></td>
- <td>This is not used in the current version of <code>examples/nx</code>,
+ <td>This is not used in the current version of <code>apps/examples/nx</code>,
was tested in a previous version)</td>
<td align="center" bgcolor="lightgrey">NO</td>
</tr>
diff --git a/nuttx/Documentation/NuttX.html b/nuttx/Documentation/NuttX.html
index 37e22a008..6929f54e1 100644
--- a/nuttx/Documentation/NuttX.html
+++ b/nuttx/Documentation/NuttX.html
@@ -8,7 +8,7 @@
<tr align="center" bgcolor="#e4e4e4">
<td>
<h1><big><font color="#3c34ec"><i>NuttX RTOS</i></font></big></h1>
- <p>Last Updated: March 19, 2011</p>
+ <p>Last Updated: March 20, 2011</p>
</td>
</tr>
</table>
@@ -948,7 +948,7 @@
<ul>
<p>
<b>STATUS:</b>
- This port boots and passes the OS test (examples/ostest).
+ This port boots and passes the OS test (apps/examples/ostest).
The port is complete and verified. As of NuttX 0.3.17, the port includes:
timer interrupts, serial console, USB driver, and SPI-based MMC/SD card
support. A verified NuttShell (<a href="NuttShell.html">NSH</a>)
@@ -982,7 +982,7 @@
<ul>
<p>
<b>STATUS:</b>
- This port boots and passes the OS test (examples/ostest) and includes a
+ This port boots and passes the OS test (apps/examples/ostest) and includes a
working implementation of the NuttShell (<a href="NuttShell.html">NSH</a>).
The port is complete and verified.
As of NuttX 5.3, the port includes only basic timer interrupts and serial console support.
@@ -1161,7 +1161,7 @@
<b>STATUS:</b>
This port was released in NuttX 5.5.
Features are the same as with the Eagle-100 LM3S6918 described above.
- The examples/ostest configuration has been successfully verified and an
+ The apps/examples/ostest configuration has been successfully verified and an
NSH configuration with telnet support is available.
MMC/SD and Networking support was not been thoroughly verified:
Current development efforts are focused on porting the NuttX window system (NX)
@@ -1357,7 +1357,7 @@
</p>
<p>
That initial, 5.6, basic release included <i>timer</i> interrupts and a <i>serial console</i> and was
- verified using the NuttX OS test (<code>examples/ostest</code>).
+ verified using the NuttX OS test (<code>apps/examples/ostest</code>).
Configurations available include include a verified NuttShell (NSH) configuration
(see the <a href="http://www.nuttx.org/NuttShell.html">NSH User Guide</a>).
The NSH configuration supports the Nucleus2G's microSD slot and additional configurations
@@ -1374,7 +1374,7 @@
</ul>
</p>
<p>
- This port includes a NuttX OS test configuration (see <code>examples/ostest</code>).
+ This port includes a NuttX OS test configuration (see <code>apps/examples/ostest</code>).
</p>
<p>
<b>Olimex LPC1766-STK</b>.
@@ -1524,7 +1524,7 @@
Since then, the basic RTOS port has solidified:
<ul>
<li>
- The port successfully passes the NuttX OS test (examples/ostest).
+ The port successfully passes the NuttX OS test (apps/examples/ostest).
</li>
<li>
A NuttShell (NSH) configuration is in place (see the <a href="http://www.nuttx.org/NuttShell.html">NSH User Guide</a>).
@@ -1534,7 +1534,7 @@
At present, I get nothing coming in the serial RXD line (probably because the pins are configured wrong or I have the MAX232 connected wrong).
</li>
</ul>
- The basic, port (including the verified examples/ostest configuration) was be released in NuttX-5.13.
+ The basic, port (including the verified apps/examples/ostest configuration) was be released in NuttX-5.13.
A complete port will include drivers for additional AVR32 UC3 devices -- like SPI and USB --- and will be available in a later release,
time permitting.
</p>
@@ -1979,7 +1979,7 @@ m68k, m68hc11, m68hc12, and SuperH ports.</blockquote>
This build for the ARM9 target includes a significant subset of OS
features, a filesystem, Ethernet driver, full TCP/IP, UDP and (minimal)
ICMP stacks (via uIP) and a small network test application: (11/8/07,
- configuration netconfig, examples/nettest)
+ configuration netconfig, apps/examples/nettest)
</p>
<pre>
text data bss dec hex filename
@@ -1988,7 +1988,7 @@ m68k, m68hc11, m68hc12, and SuperH ports.</blockquote>
<p>
Another build for the ARM9 target includes a minimal OS feature
set, Ethernet driver, full TCP/IP and (minimal) ICMP stacks, and
- a small webserver: (11/20/07, configuration uipconfig, examples/uip)
+ a small webserver: (11/20/07, configuration uipconfig, apps/examples/uip)
</p>
<pre>
text data bss dec hex filename
@@ -2224,6 +2224,10 @@ nuttx-5.20 2011-xx-xx Gregory Nutt &lt;spudmonkey@racsa.co.cr&gt;
* examples/nsh and apps/nshlib - Move the core NuttShell (NSH) logic
out of the exemples directory and into the apps/directory where
it belongs.
+ * apps/Makefile and configs/*/appconfig - Use '=' as the delimiter
+ instead of '/' so that sub-directories in apps/ can be used.
+ * apps/vsn - Move all VSN apps to apps/vsn.
+ * nuttx/examples moved to apps/examples
apps-5.20 2011-xx-xx Gregory Nutt &lt;spudmonkey@racsa.co.cr&gt;
diff --git a/nuttx/Documentation/NuttXNxFlat.html b/nuttx/Documentation/NuttXNxFlat.html
index b1948f47f..b08b65801 100644
--- a/nuttx/Documentation/NuttXNxFlat.html
+++ b/nuttx/Documentation/NuttXNxFlat.html
@@ -10,7 +10,7 @@
<td>
<h1><big><font color="#3c34ec"><i>NXFLAT</i></font></big></h1>
<h2><font color="#dc143c">&gt;&gt;&gt; Under Construction &lt;&lt;&lt;</font></h2>
- <p>Last Updated: June 26, 2009</p>
+ <p>Last Updated: March 20, 2011</p>
</td>
</tr>
</table>
@@ -253,7 +253,7 @@
<p>
The initial release of NXFLAT was made in NuttX version 0.4.9.
- Testing is limited to the tests found under <code>examples/nxflat</code> in the source tree.
+ Testing is limited to the tests found under <code>apps/examples/nxflat</code> in the source tree.
Some known problems exist
(see the <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/TODO?view=log">TODO</a> list).
As such, NXFLAT is currently in an early alpha phase.
@@ -366,7 +366,7 @@ any following arguments.
<p>
Below is a snippet from an NXFLAT make file (simplified from NuttX
- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/examples/nxflat/tests/hello/Makefile?view=log">
+ <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/apps/examples/nxflat/tests/hello/Makefile?view=log">
Hello, World!</a> example.
<p>
<ul><table width="50%">
diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html
index 2d77d4ab9..85fc8010d 100644
--- a/nuttx/Documentation/NuttxPortingGuide.html
+++ b/nuttx/Documentation/NuttxPortingGuide.html
@@ -12,7 +12,7 @@
<h1><big><font color="#3c34ec">
<i>NuttX RTOS Porting Guide</i>
</font></big></h1>
- <p>Last Updated: March 19, 2011</p>
+ <p>Last Updated: March 20, 2011</p>
</td>
</tr>
</table>
@@ -37,30 +37,31 @@
<a href="#summaryofarchfiles">2.2.2 Summary of Files</a><br>
<a href="#supportedarchitectures">2.2.3 Supported Architectures</a>
</ul>
- <a href="#DirStructBinFmt">2.2 binfmt/</a><br>
+ <a href="#DirStructBinFmt">2.3 binfmt/</a><br>
<a href="#DirStructConfigs">2.4 configs/</a>
<ul>
- <a href="#configsdirectorystructure">2.3.1 Subdirectory Structure</a><br>
- <a href="#summaryofconfigfiles">2.3.2 Summary of Files</a>
+ <a href="#configsdirectorystructure">2.4.1 Subdirectory Structure</a><br>
+ <a href="#summaryofconfigfiles">2.4.2 Summary of Files</a>
<ul>
<a href="#boardlogic">2.4.2.1 Board Specific Logic</a><br>
- <a href="#boardconfigsubdirs">2.3.2.2 Board Specific Configuration Sub-Directories</a>
+ <a href="#boardconfigsubdirs">2.4.2.2 Board Specific Configuration Sub-Directories</a>
</ul>
<a href="#supportedboards">2.4.3 Supported Boards</a>
</ul>
- <a href="#DirStructDrivers">2.5 drivers/</a><br>
- <a href="#DirStructExamples">2.6 examples/</a><br>
- <a href="#DirStructFs">2.7 fs/</a><br>
- <a href="#DirStructGraphics">2.8 graphics/</a><br>
- <a href="#DirStructInclude">2.9 include/</a><br>
- <a href="#DirStructLib">2.10 lib/</a><br>
- <a href="#DirStructLibXX">2.11 libxx/</a><br>
- <a href="#DirStructMm">2.12 mm/</a><br>
- <a href="#DirStructNet">2.13 net</a><br>
- <a href="#DirStructNetUtils">2.14 netutils</a><br>
- <a href="#DirStructSched">2.15 sched/</a><br>
- <a href="#DirStructTools">2.16 tools/</a><br>
- <a href="#topmakefile">2.17 Makefile</a>
+ <a href="#DirStructDrivers">2.5 nuttx/drivers/</a><br>
+ <a href="#DirStructFs">2.6 nuttx/fs/</a><br>
+ <a href="#DirStructGraphics">2.7 nuttx/graphics/</a><br>
+ <a href="#DirStructInclude">2.8 nuttx/include/</a><br>
+ <a href="#DirStructLib">2.9 nuttx/lib/</a><br>
+ <a href="#DirStructLibXX">2.10 nuttx/libxx/</a><br>
+ <a href="#DirStructMm">2.11 nuttx/mm/</a><br>
+ <a href="#DirStructNet">2.12 nuttx/net</a><br>
+ <a href="#DirStructSched">2.13 nuttx/sched/</a><br>
+ <a href="#DirStructTools">2.14 nuttx/tools/</a><br>
+ <a href="#topmakefile">2.15 nuttx/Makefile</a>
+ <a href="#DirStructNetUtils">2.16 apps/netutils</a><br>
+ <a href="#DirStructNshLib">2.17 apps/nshlib</a><br>
+ <a href="#DirStructExamples">2.18 apps/examples/</a><br>
</ul>
<a href="#configandbuild">3.0 Configuring and Building</a>
<ul>
@@ -200,10 +201,6 @@
| | |-- <i>(driver-specific sub-directories)/</i>
| | | `-- <i>(driver-specific source files)</i>
| | `-- <i>(common driver source files)</i>
-| |-- <a href="#DirStructExamples">examples</a>/
-| | `-- <i>(example)</i>/
-| | |-- Makefile
-| | `-- <i>(example source files)</i>
| |-- <a href="#DirStructFs">fs</a>/
| | |-- Makefile
| | |-- <i>(file system-specific sub-directories)</i>/
@@ -245,14 +242,18 @@
| |-- <i>(network feature sub-directories)</i>/
| | `-- <i>(network feature source files)</i>
| `-- <i>(netutils common files)</i>
- |-- nshlib/
+ |-- <a href="#DirStructNshLib">nshlib</a>/
| |-- Makefile
| `-- <i>NuttShell (NSH) files</i>
- `-- <i>(Board-specific applications)</i>/
- |-- Makefile
- |-- <i>(Board-specific application sub-directories)</i>/
- | `-- <i>(Board-specific application source files)</i>
- `-- <i>(Board-specific common files)</i>
+ |-- <i>(Board-specific applications)</i>/
+ | |-- Makefile
+ | |-- <i>(Board-specific application sub-directories)</i>/
+ | | `-- <i>(Board-specific application source files)</i>
+ | `-- <i>(Board-specific common files)</i>
+ `-- <a href="#DirStructExamples">examples</a>/
+ `-- <i>(example)</i>/
+ |-- Makefile
+ `-- <i>(example source files)</i>
</pre></ul>
<p>
@@ -295,7 +296,7 @@
General documentation for the NuttX OS resides in this directory.
</p>
-<h2>2.2 <a name="DirStructArch">arch</a></h2>
+<h2>2.2 <a name="DirStructArch">nuttx/arch</a></h2>
<h3><a name="archdirectorystructure">2.2.1 Subdirectory Structure</a></h3>
<p>
@@ -460,7 +461,7 @@
<li><code>arch/arm/include/lpc214x</code> and <code>arch/arm/src/lpc214x</code>:
These directories provide support for NXP LPC214x family of
processors.
- STATUS: This port boots and passes the OS test (examples/ostest).
+ STATUS: This port boots and passes the OS test (apps/examples/ostest).
The port is complete and verified. As of NuttX 0.3.17, the port includes:
timer interrupts, serial console, USB driver, and SPI-based MMC/SD card
support. A verified NuttShell configuration is also available.
@@ -544,21 +545,21 @@
of progress
</p>
-<h2>2.3 <a name="DirStructBinFmt">binfmt</a></h2>
+<h2>2.3 <a name="DirStructBinFmt">nuttx/binfmt</a></h2>
<p>
The <code>binfmt/</code> subdirectory contains logic for loading binaries in the file
system into memory in a form that can be used to execute them.
</p>
-<h2>2.4 <a name="DirStructConfigs">configs</a></h2>
+<h2>2.4 <a name="DirStructConfigs">nuttx/configs</a></h2>
<p>
The <code>configs/</code> subdirectory contains configuration data for each board.
These board-specific configurations plus the architecture-specific configurations in
the <code>arch/</code> subdirectory complete define a customized port of NuttX.
</p>
-<h3><a name="configsdirectorystructure">2.3.1 Subdirectory Structure</a></h3>
+<h3><a name="configsdirectorystructure">2.4.1 Subdirectory Structure</a></h3>
<p>
The configs directory contains board specific configuration files. Each board must
provide a subdirectory &lt;board-name&gt; under <code>configs/</code> with the following characteristics:
@@ -589,8 +590,8 @@
</small></p>
</ul>
-<h3><a name="summaryofconfigfiles">2.3.2 Summary of Files</a></h3>
-<h4><a name="boardlogic">2.3.2.1 Board Specific Logic</a></h4>
+<h3><a name="summaryofconfigfiles">2.4.2 Summary of Files</a></h3>
+<h4><a name="boardlogic">2.4.2.1 Board Specific Logic</a></h4>
<ul>
<li>
<code>include/</code>:
@@ -612,7 +613,7 @@
It must support the following targets: <code>libext$(LIBEXT)</code>, <code>clean</code>, and <code>distclean</code>.
</li>
</ul>
-<h4><a name="boardconfigsubdirs">2.3.2.2 Board Specific Configuration Sub-Directories</a></h4>
+<h4><a name="boardconfigsubdirs">2.4.2.2 Board Specific Configuration Sub-Directories</a></h4>
<p>
The <code>configs/</code><i>&lt;board-name&gt;</i><code>/</code> sub-directory holds all of the
files that are necessary to configure NuttX for the particular board.
@@ -676,7 +677,7 @@
</li>
</ul>
-<h3><a name="supportedboards">2.3.3 Supported Boards</a></h3>
+<h3><a name="supportedboards">2.4.3 Supported Boards</a></h3>
<p>
All of the specific boards supported by NuttX are identified below.
These are the specific <i>&lt;board-name&gt;</i>'s that may be used to configure NuttX
@@ -790,7 +791,7 @@
is available to build these toolchains under Linux or Cygwin.
</blockquote></small></p>
-<h2>2.5 <a name="DirStructDrivers">drivers</a></h2>
+<h2>2.5 <a name="DirStructDrivers">nuttx/drivers</a></h2>
<p>
This directory holds architecture-independent device drivers.
@@ -816,13 +817,7 @@ drivers/
`-- <i>(common driver source files)</i>
</pre></ul>
-<h2>2.6 <a name="DirStructExamples">examples</a></h2>
-
-<p>
- Example and test programs to build against.
-</p>
-
-<h2>2.7 <a name="DirStructFs">fs</a></h2>
+<h2>2.6 <a name="DirStructFs">nuttx/fs</a></h2>
<p>
This directory contains the NuttX file system.
@@ -840,7 +835,7 @@ fs/
`-- <i>(common file system source files)</i>
</pre></ul>
-<h2>2.8 <a name="DirStructGraphics">graphics</a></h2>
+<h2>2.7 <a name="DirStructGraphics">nuttx/graphics</a></h2>
<p>
This directory contains files for graphics/video support under NuttX.
@@ -857,7 +852,7 @@ graphics/
`-- <i>(common file system source files)</i>
</pre></ul>
-<h2>2.9 <a name="DirStructInclude">include</a></h2>
+<h2>2.8 <a name="DirStructInclude">nuttx/include</a></h2>
<p>
This directory holds NuttX header files.
Standard header files file retained in can be included in the <i>normal</i> fashion:
@@ -886,30 +881,64 @@ include/
`-- <i>(more standard header files)</i>
</per></ul>
-<h2>2.10 <a name="DirStructLib">lib</a></h2>
+<h2>2.9 <a name="DirStructLib">nuttx/lib</a></h2>
<p>
This directory holds a collection of standard libc-like functions with custom
interfaces into NuttX.
</p>
-<h2>2.11 <a name="DirStructLibXX">libxx</a></h2>
+<h2>2.10 <a name="DirStructLibXX">nuttx/libxx</a></h2>
<p>
This directory holds a tiny, minimal standard std C++ that can be used to
build some, simple C++ applications in NuttX.
</p>
-<h2>2.12 <a name="DirStructMm">mm</a></h2>
+<h2>2.11 <a name="DirStructMm">nuttx/mm</a></h2>
<p>
This is the NuttX memory manager.
</p>
-<h2>2.13 <a name="DirStructNet">net</a></h2>
+<h2>2.12 <a name="DirStructNet">nuttx/net</a></h2>
<p>
This directory contains the implementation of the socket APIs.
The subdirectory, <code>uip</code> contains the uIP port.
</P>
-<h2>2.14 <a name="DirStructNetUtils">netutils</a></h2>
+<h2>2.13 <a name="DirStructSched">nuttx/sched</a></h2>
+<p>
+ The files forming core of the NuttX RTOS reside here.
+</p>
+
+<h2>2.14 <a name="DirStructTools">nuttx/tools</a></h2>
+<p>
+ This directory holds a collection of tools and scripts to simplify
+ configuring, building and maintaining NuttX.
+</p>
+<ul><pre>
+tools/
+|-- Makefile.mkconfig
+|-- configure.sh
+|-- incdir.sh
+|-- indent.sh
+|-- link.sh
+|-- mkconfig.c
+|-- mkdeps.sh
+|-- mkimage.sh
+|-- mknulldeps.sh
+|-- mkromfsimg.sh
+|-- unlink.sh
+|-- winlink.sh
+`-- zipme
+</pre></ul>
+
+<h2>2.15 <a name="topmakefile">nuttx/Makefile</a></h2>
+<p>
+ The top-level <code>Makefile</code> in the <code>${TOPDIR}</code> directory contains all of the top-level control
+ logic to build NuttX.
+ Use of this <code>Makefile</code> to build NuttX is described <a href="#buildingnuttx">below</a>.
+</p>
+
+<h2>2.16 <a name="DirStructNetUtils">apps/netutils</a></h2>
<p>
This directory contains most of the network applications.
Some of these are original with NuttX (like tftpc and dhcpd) and others were leveraged from the uIP-1.0 apps directory.
@@ -951,38 +980,14 @@ netutils/
`-- <i>(netutils common files)</i>
</pre></ul>
-<h2>2.15 <a name="DirStructSched">sched</a></h2>
+<h2>2.17 <a name="DirStructNshLib">apps/nshlib</a></h2>
<p>
- The files forming core of the NuttX RTOS reside here.
+ This directory contains for the core of the NuttShell (NSH) application.
</p>
-<h2>2.16 <a name="DirStructTools">tools</a></h2>
+<h2>2.18 <a name="DirStructExamples">apps/examples</a></h2>
<p>
- This directory holds a collection of tools and scripts to simplify
- configuring, building and maintaining NuttX.
-</p>
-<ul><pre>
-tools/
-|-- Makefile.mkconfig
-|-- configure.sh
-|-- incdir.sh
-|-- indent.sh
-|-- link.sh
-|-- mkconfig.c
-|-- mkdeps.sh
-|-- mkimage.sh
-|-- mknulldeps.sh
-|-- mkromfsimg.sh
-|-- unlink.sh
-|-- winlink.sh
-`-- zipme
-</pre></ul>
-
-<h2>2.17 <a name="topmakefile">Makefile</a></h2>
-<p>
- The top-level <code>Makefile</code> in the <code>${TOPDIR}</code> directory contains all of the top-level control
- logic to build NuttX.
- Use of this <code>Makefile</code> to build NuttX is described <a href="#buildingnuttx">below</a>.
+ Example and test programs to build against.
</p>
<table width ="100%">
@@ -2663,10 +2668,9 @@ extern void up_ledoff(int led);
<ul>
<li>
<p>
- <code>CONFIG_APP_DIR</code>: Ldentifies the directory that builds the application to link with NuttX.
- This symbol must be assigned to the path to the application build directory <i>relative</i> to the NuttX top build direcory.
- As an an example, there are several example applicatins in the NuttX <code>examples/</code> sub-directory.
- To use one of these example applications, say <code>nsh</code>, you would set <code>CONFIG_APP_DIR=examples/nsh</code>.
+ <code>CONFIG_APP_DIR</code>: Identifies the directory that builds the application to link with NuttX.
+ This symbol must be assigned to the path to the application build directory <i>relative</i> to the NuttX top build directory.
+ If the application resides in the top-level <code>apps</code> directory, it is not necessary to define <code>CONFIG_APP_DIR</code>.
If you had an application directory and the NuttX directory both within another directory like this:
<ul><pre>
build
@@ -2874,7 +2878,7 @@ build
<li>
<code>CONFIG_NXFLAT</code>: Enable support for the NXFLAT binary format.
This format will support execution of NuttX binaries located
- in a ROMFS filesystem (see <code>examples/nxflat</code>).
+ in a ROMFS filesystem (see <code>apps/examples/nxflat</code>).
</li>
<li>
<code>CONFIG_SCHED_WORKQUEUE</code>: Create a dedicated "worker" thread to
diff --git a/nuttx/Documentation/README.html b/nuttx/Documentation/README.html
index 63f83166b..eff38044d 100755
--- a/nuttx/Documentation/README.html
+++ b/nuttx/Documentation/README.html
@@ -165,9 +165,6 @@
| | `- <a href="nuttx/configs/README.txt?view=log"><b><i>README.txt</i></b></a>
| |- drivers/
| | `- <a href="nuttx/drivers/README.txt?view=log"><b><i>README.txt</i></b></a>
- | |- examples/
- | | |- <a href="nuttx/examples/pashello/README.txt?view=log">pashello/README.txt</a>
- | | `- <a href="nuttx/examples/README.txt?view=log"><b><i>README.txt</i></b></a>
| |- graphics/
| | `- <a href="nuttx/graphics/README.txt?view=log"><b><i>README.txt</i></b></a>
| |- libxx/
@@ -180,6 +177,9 @@
| `- <a href="apps/netutils/README?view=log"><b><i>README</i></b></a>
|- nshlib/
| |- <a href="apps/nshlib/README.txt?view=log"><b><i>README.txt</i></b></a>
+ |- examples/
+ | |- <a href="apps/examples/pashello/README.txt?view=log">pashello/README.txt</a>
+ | `- <a href="apps/examples/README.txt?view=log"><b><i>README.txt</i></b></a>
`- vsn/
|- <a href="apps/vsn/free/README.txt?view=log">free/README.txt</a>
|- <a href="apps/vsn/hello/README.txt?view=log">hello/README.txt</a>
diff --git a/nuttx/Documentation/UsbTrace.html b/nuttx/Documentation/UsbTrace.html
index ac1a7e750..2f08f9ef2 100755
--- a/nuttx/Documentation/UsbTrace.html
+++ b/nuttx/Documentation/UsbTrace.html
@@ -9,7 +9,7 @@
<tr align="center" bgcolor="#e4e4e4">
<td>
<h1><big><font color="#3c34ec"><i>NuttX USB Device Trace</i></font></big></h1>
- <p>Last Updated: February 25, 2010</p>
+ <p>Last Updated: March 20, 2011</p>
</td>
</tr>
</table>
@@ -134,7 +134,7 @@
Otherwise, the trace data goes to console.
<p>
<p><b>Example</b>.
- Here is an example of USB trace output using <code>examples/usbserial</code> for an LPC1768 platform with the following NuttX configuration settings:
+ Here is an example of USB trace output using <code>apps/examples/usbserial</code> for an LPC1768 platform with the following NuttX configuration settings:
</p>
<ul>
<li><code>CONFIG_DEBUG</code>, <code>CONFIG_DEBUG_VERBOSE</code>, <code>CONFIG_USB</code>