From d48dc04963a617598562d8d40756c5bc10448790 Mon Sep 17 00:00:00 2001
From: patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>
Date: Mon, 29 Oct 2012 21:18:51 +0000
Subject: Update documentation to at least reference the ELF loader.

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@5276 42af7a65-404d-4744-a932-0658087f49c3
---
 nuttx/Documentation/NuttX.html             | 13 +++++--
 nuttx/Documentation/NuttxPortingGuide.html | 55 ++++++++++++++++++++++++++----
 2 files changed, 59 insertions(+), 9 deletions(-)

(limited to 'nuttx/Documentation')

diff --git a/nuttx/Documentation/NuttX.html b/nuttx/Documentation/NuttX.html
index 06b61a4de..f3f13d38a 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: September 29, 2012</p>
+      <p>Last Updated: October 29, 2012</p>
     </td>
   </tr>
 </table>
@@ -448,13 +448,20 @@
       <li>ROMFS filesystem support.</li>
     </p>
 </tr>
+<tr>
+  <td><br></td>
+  <td>
+    <p>
+      <li><a href="NuttXNxFlat.html">Loadable ELF Modules</a>.
+      Support for separately linked, loadable ELF modules.
+    </p>
+</tr>
 <tr>
   <td><br></td>
   <td>
     <p>
       <li><a href="NuttXNxFlat.html">NXFLAT</a>.
-      A new binary format call NXFLAT that can be used to 
-      execute separately linked programs in place in a file system.
+      NXFLAT is a binary format that can be XIP from a file system.
     </p>
 </tr>
 <tr>
diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html
index 96c301295..dd9d66881 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: October 20, 2012</p>
+      <p>Last Updated: October 29, 2012</p>
     </td>
   </tr>
 </table>
@@ -4070,11 +4070,6 @@ build
     desciptors by task_create() when a new task is started.
     If set, all sockets will appear to be closed in the new task.
   </li>
-  <li>
-    <code>CONFIG_NXFLAT</code>: Enable support for the NXFLAT binary format.
-    This format will support execution of NuttX binaries located
-    in a ROMFS file system (see <code>apps/examples/nxflat</code>).
-  </li>
   <li>
     <code>CONFIG_SCHED_WORKQUEUE</code>: Create a dedicated "worker" thread to
     handle delayed processing from interrupt handlers.  This feature
@@ -4144,6 +4139,54 @@ build
   </li>
 </ul>
 
+<p>
+  Binary Loaders:
+</p>
+<ul>
+  <li>
+    <code>CONFIG_BINFMT_DISABLE</code>: By default, support for loadable binary formats is built.
+    This logic may be suppressed be defining this setting.
+  </li>
+  <li>
+    <code>CONFIG_BINFMT_CONSTRUCTORS</code>: Build in support for C++ constructors in loaded modules.
+  </li>
+  <li>
+    <code>CONFIG_SYMTAB_ORDEREDBYNAME</code>: Symbol tables are order by name (rather than value).
+  </li>
+  <li>
+    <code>CONFIG_NXFLAT</code>: Enable support for the NXFLAT binary format.
+    This format will support execution of NuttX binaries located
+    in a ROMFS file system (see <code>apps/examples/nxflat</code>).
+  </li>
+  <li>
+    <code>CONFIG_ELF</code>: Enable support for the ELF binary format.
+    This format will support execution of ELF binaries copied from a file system and relocated into RAM (see <code>apps/examples/elf</code>).
+  </li>
+  <p>
+    If <code>CONFIG_ELF</code> is selected, then these additional options are available:
+  </p>
+  <li>
+    <code>CONFIG_ELF_ALIGN_LOG2</code>: Align all sections to this Log2 value:  0->1, 1->2, 2->4, etc.
+  </li>
+  <li>
+    <code>CONFIG_ELF_STACKSIZE</code>: This is the default stack size that will will be used when starting ELF binaries.
+  </li>
+  <li>
+    <code>CONFIG_ELF_BUFFERSIZE</code>: This is an I/O buffer that is used to access the ELF file.  Variable length items will need to be read (such as symbol names).
+    This is really just this initial size of the buffer; it will be reallocated as necessary to hold large symbol names).
+    Default: 128
+  </li>
+  <li>
+    <code>CONFIG_ELF_BUFFERINCR</code>: This is an I/O buffer that is used to access the ELF file.  Variable length items will need to be read (such as symbol names).
+    This value specifies the size increment to use each time the buffer is reallocated.
+    Default: 32
+  </li>
+  <li>
+    <code>CONFIG_ELF_DUMPBUFFER</code>: Dump various ELF buffers for debug purposes.
+    This option requires <code>CONFIG_DEBUG</code> and <code>CONFIG_DEBUG_VERBOSE</code>.
+  </li>
+</ul>
+
 <p>
   System Logging:
 </p>
-- 
cgit v1.2.3