From 0587988c3752c97d158b84afa34fb836b9642b62 Mon Sep 17 00:00:00 2001
From: patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>
Date: Wed, 17 Jun 2009 16:42:33 +0000
Subject: add description of new directories

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@1893 42af7a65-404d-4744-a932-0658087f49c3
---
 nuttx/Documentation/NuttxPortingGuide.html | 81 +++++++++++++++++++-----------
 1 file changed, 52 insertions(+), 29 deletions(-)

(limited to 'nuttx/Documentation/NuttxPortingGuide.html')

diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html
index 48a6b5fd9..bc36b19ac 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: June 15, 2009</p>
+      <p>Last Updated: June 17, 2009</p>
     </td>
   </tr>
 </table>
@@ -37,28 +37,30 @@
       <a href="#summaryofarchfiles">2.2.2 Summary of Files</a><br>
       <a href="#supportedarchitectures">2.2.3 Supported Architectures</a>
     </ul>
-    <a href="#DirStructConfigs">2.3 configs/</a>
+    <a href="#DirStructBinFmt">2.2 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>
       <ul>
-        <a href="#boardlogic">2.3.2.1 Board Specific Logic</a><br>
+        <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>
       </ul>
-      <a href="#supportedboards">2.3.3 Supported Boards</a>
+      <a href="#supportedboards">2.4.3 Supported Boards</a>
     </ul>
-    <a href="#DirStructDrivers">2.4 drivers/</a><br>
-    <a href="#DirStructExamples">2.5 examples/</a><br>
-    <a href="#DirStructFs">2.6 fs/</a><br>
-    <a href="#DirStructGraphics">2.7 graphics/</a><br>
-    <a href="#DirStructInclude">2.8 include/</a><br>
-    <a href="#DirStructLib">2.9 lib/</a><br>
-    <a href="#DirStructMm">2.10 mm/</a><br>
-    <a href="#DirStructNet">2.11 net</a><br>
-    <a href="#DirStructNetUtils">2.12 netutils</a><br>
-    <a href="#DirStructSched">2.13 sched/</a><br>
-    <a href="#DirStructTools">2.14 tools/</a><br>
-    <a href="#topmakefile">2.15 Makefile</a>
+    <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>
   </ul>
   <a href="#configandbuild">3.0 Configuring and Building</a>
   <ul>
@@ -170,6 +172,11 @@
 |   |       |--<i>&lt;other-chips&gt;</i>/
 |   |       `-- <i>(architecture-specific source files)</i>
 |   `-- <i>&lt;other-architecture directories&gt;</i>/
+|-- <a href="#DirStructBinFmt">binfmt</a>/
+|   |-- Makefile
+|   |-- <i>(binfmt-specific sub-directories)</i>/
+|   |   `-- <i>(binfmt-specific source files)</i>
+|   `-- <i>(common binfmt source files)</i>
 |-- <a href="#DirStructConfigs">configs</a>/
 |   |-- <i>&lt;board-name&gt;</i>/
 |   |   |-- include/
@@ -208,6 +215,9 @@
 |-- <a href="#DirStructLib">lib</a>/
 |   |-- Makefile
 |   `-- <i>(lib source files)</i>
+|-- <a href="#DirStructLibXX">libxx</a>/
+|   |-- Makefile
+|   `-- <i>(libxx management source files)</i>
 |-- <a href="#DirStructMm">mm</a>/
 |   |-- Makefile
 |   `-- <i>(memory management source files)</i>
@@ -507,7 +517,14 @@
   of progress
 </p>
 
-<h2>2.3 <a name="DirStructConfigs">configs</a></h2>
+<h2>2.3 <a name="DirStructBinFmt">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>
 <p>
   The <code>configs/</code> subdirectory contains configuration data for each board.
   These board-specific configurations plus the architecture-specific configurations in
@@ -722,7 +739,7 @@
   is available to build these toolchains under Linux or Cygwin.
 </blockquote></small></p>
 
-<h2>2.4 <a name="DirStructDrivers">drivers</a></h2>
+<h2>2.5 <a name="DirStructDrivers">drivers</a></h2>
 
 <p>
   This directory holds architecture-independent device drivers.
@@ -745,13 +762,13 @@ drivers/
 `-- <i>(common driver source files)</i>
 </pre></ul>
 
-<h2>2.5 <a name="DirStructExamples">examples</a></h2>
+<h2>2.6 <a name="DirStructExamples">examples</a></h2>
 
 <p>
   Example and test programs to build against.
 </p>
 
-<h2>2.6 <a name="DirStructFs">fs</a></h2>
+<h2>2.7 <a name="DirStructFs">fs</a></h2>
 
 <p>
   This directory contains the NuttX file system.
@@ -769,7 +786,7 @@ fs/
  `-- <i>(common file system source files)</i>
 </pre></ul>
 
-<h2>2.7 <a name="DirStructGraphics">graphics</a></h2>
+<h2>2.8 <a name="DirStructGraphics">graphics</a></h2>
 
 <p>
   This directory contains files for graphics/video support under NuttX.
@@ -786,7 +803,7 @@ graphics/
 `-- <i>(common file system source files)</i>
 </pre></ul>
 
-<h2>2.8 <a name="DirStructInclude">include</a></h2>
+<h2>2.9 <a name="DirStructInclude">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:
@@ -815,24 +832,30 @@ include/
     `-- <i>(more standard header files)</i>
 </per></ul>
 
-<h2>2.9 <a name="DirStructLib">lib</a></h2>
+<h2>2.10 <a name="DirStructLib">lib</a></h2>
 <p>
   This directory holds a collection of standard libc-like functions with custom
   interfaces into NuttX.
 </p>
 
-<h2>2.10 <a name="DirStructMm">mm</a></h2>
+<h2>2.11 <a name="DirStructLibXX">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>
 <p>
   This is the NuttX memory manager.
 </p>
 
-<h2>2.11 <a name="DirStructNet">net</a></h2>
+<h2>2.13 <a name="DirStructNet">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.12 <a name="DirStructNetUtils">netutils</a></h2>
+<h2>2.14 <a name="DirStructNetUtils">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.
@@ -871,12 +894,12 @@ netutils/
 `-- <i>(netutils common files)</i>
 </pre></ul>
 
-<h2>2.13 <a name="DirStructSched">sched</a></h2>
+<h2>2.15 <a name="DirStructSched">sched</a></h2>
 <p>
   The files forming core of the NuttX RTOS reside here.
 </p>
 
-<h2>2.14 <a name="DirStructTools">tools</a></h2>
+<h2>2.16 <a name="DirStructTools">tools</a></h2>
 <p>
   This directory holds a collection of tools and scripts to simplify
   configuring, building and maintaining NuttX.
@@ -897,7 +920,7 @@ tools/
 `-- zipme
 </pre></ul>
 
-<h2>2.15 <a name="topmakefile">Makefile</a></h2>
+<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.
-- 
cgit v1.2.3