diff options
author | Gregory Nutt <gnutt@nuttx.org> | 2013-04-22 16:46:15 -0600 |
---|---|---|
committer | Gregory Nutt <gnutt@nuttx.org> | 2013-04-22 16:46:15 -0600 |
commit | 377190ce1dbf843f6ccfa4283eb87ab3ee592c44 (patch) | |
tree | c3632177f460a374666170914096ce2bae357f64 /nuttx/Documentation | |
parent | ff646db32dc491f86efd47546186c82ed08424bb (diff) | |
download | px4-nuttx-377190ce1dbf843f6ccfa4283eb87ab3ee592c44.tar.gz px4-nuttx-377190ce1dbf843f6ccfa4283eb87ab3ee592c44.tar.bz2 px4-nuttx-377190ce1dbf843f6ccfa4283eb87ab3ee592c44.zip |
Documentation now expects autogenerated configuration variable documenation at Documentation/NuttXConfigVariables.html
Diffstat (limited to 'nuttx/Documentation')
-rw-r--r-- | nuttx/Documentation/NuttX.html | 21 | ||||
-rw-r--r-- | nuttx/Documentation/NuttXDocumentation.html | 2 | ||||
-rw-r--r-- | nuttx/Documentation/NuttxPortingGuide.html | 8 | ||||
-rw-r--r-- | nuttx/Documentation/NuttxUserGuide.html | 4 |
4 files changed, 28 insertions, 7 deletions
diff --git a/nuttx/Documentation/NuttX.html b/nuttx/Documentation/NuttX.html index 1d7c0c2ec..2889f46c4 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: April 17, 2013</p> + <p>Last Updated: April 22, 2013</p> </td> </tr> </table> @@ -16,7 +16,7 @@ <table width ="100%"> <tr bgcolor="#e4e4e4"> <td> - <h1>Table of Contents</h1> + <h1>Table of Contents</h1> </td> </tr> </table> @@ -1019,7 +1019,7 @@ This configuration file contains a long list of settings that control what is built into NuttX and what is not. There are hundreds of such settings - (see the <a href="NuttxPortingGuide.html#apndxconfigs">NuttX Porting Guide</a> + (see the <a href="NuttXConfigVariables.html">Configuration Variable Documentation</a> for a partial list that excludes platform specific settings). These many, many configuration options allow NuttX to be highly tuned to meet size requirements. @@ -4177,6 +4177,10 @@ pascal-3.0 2011-05-15 Gregory Nutt <gnutt@nuttx.org> </tr> <tr> <td valign="top" width="22"><img height="20" width="20" src="favicon.ico"></td> + <td><a href="NuttXConfigVariables.html">Configuration Variables</a><sup>1</sup></td> +</tr> +<tr> + <td valign="top" width="22"><img height="20" width="20" src="favicon.ico"></td> <td><a href="NuttShell.html">NuttShell (NSH)</a></td> </tr> <tr> @@ -4215,7 +4219,14 @@ pascal-3.0 2011-05-15 Gregory Nutt <gnutt@nuttx.org> <td valign="top" width="22"><img height="20" width="20" src="favicon.ico"></td> <td><a href="UsbTrace.html">USB Device Driver Tracing</a></td> </tr> -</center></ul> +</table></ul> + +<small><blockquote> + <sup>1</sup> + This configuration variable document is auto-generated using the <a href="http://sourceforge.net/p/nuttx/git/ci/master/tree/nuttx/tools/kconfig2html.c">kconfig2html</a> tool + That tool analyzes the NuttX <code>Kconfig</code> files and generates the HTML document. + As a consequence, this file may not be present at any given time but can be regenerated following the instructions in <code>tools</code> directory <a href="http://sourceforge.net/p/nuttx/git/ci/master/tree/nuttx/tools/README.txt">README</a> file. +</blockquote></small> <small> <table width ="100%"> @@ -4225,6 +4236,7 @@ pascal-3.0 2011-05-15 Gregory Nutt <gnutt@nuttx.org> </td> </tr> </table> + <ul> <li>ARM, ARM7 ARM7TDMI, ARM9, ARM920T, ARM926EJS Cortex-M3 are trademarks of Advanced RISC Machines, Limited.</li> <li>Cygwin is a trademark of Red Hat, Incorporated.</li> @@ -4244,4 +4256,3 @@ pascal-3.0 2011-05-15 Gregory Nutt <gnutt@nuttx.org> </body> </html> - diff --git a/nuttx/Documentation/NuttXDocumentation.html b/nuttx/Documentation/NuttXDocumentation.html index b502adc68..e34494575 100644 --- a/nuttx/Documentation/NuttXDocumentation.html +++ b/nuttx/Documentation/NuttXDocumentation.html @@ -31,6 +31,7 @@ <li><a href="NuttXGettingStarted.html" target="main">Getting Started</a></li> <li><a href="NuttxUserGuide.html" target="main">User Guide</a></li> <li><a href="NuttxPortingGuide.html" target="main">Porting Guide</a></li> + <li><a href="NuttXConfigVariables.html">Configuration Variables</a></li> <li><a href="NuttShell.html" target="main">NuttShell (NSH)</a></li> <li><a href="NuttXBinfmt.html" target="main">Binary Loader</a></li> <li><a href="NuttXNxFlat.html" target="main">NXFLAT</a></li> @@ -42,6 +43,7 @@ <li><a href="README.html" target="main">README Files</a></li> <li><a href="ChangeLog.txt" target="main">Change Log</a></li> <li><a href="TODO.txt" target="main">To-Do List</a></li> + </td> </tr> <tr> <td align="center" valign="top" width="22"> diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html index 2a7865a95..642cb1a3c 100644 --- a/nuttx/Documentation/NuttxPortingGuide.html +++ b/nuttx/Documentation/NuttxPortingGuide.html @@ -4225,6 +4225,14 @@ void (*notify)(FAR struct pm_callback_s *cb, enum pm_state_e pmstate); The following variables are recognized by the build (you may also include architecture-specific settings). </p> +<p> + <b>Note</b>. + This appendix is deprecated. + Documentation of NuttX configuration is now provided in a separate, auto-generated <a href="NuttXConfigVariables.html">Configuration Variable Document</a>. + That configuration variable document is generated using the <a href="http://sourceforge.net/p/nuttx/git/ci/master/tree/nuttx/tools/kconfig2html.c">kconfig2html</a> tool + That tool analyzes the NuttX <code>Kconfig</code> files and generates the HTML document. + As a consequence, this file may not be present at any given time but can be regenerated following the instructions in <code>tools</code> directory <a href="http://sourceforge.net/p/nuttx/git/ci/master/tree/nuttx/tools/README.txt">README</a> file. +</p> <h2>Architecture selection</h2> <p> diff --git a/nuttx/Documentation/NuttxUserGuide.html b/nuttx/Documentation/NuttxUserGuide.html index a12e61335..5d8f48767 100644 --- a/nuttx/Documentation/NuttxUserGuide.html +++ b/nuttx/Documentation/NuttxUserGuide.html @@ -13,7 +13,7 @@ <h1><big><font color="#3c34ec"><i>NuttX Operating System<p>User's Manual</i></font></big></h1> <p><small>by</small></p> <p>Gregory Nutt<p> - <p>Last Updated: February 13, 2013</p> + <p>Last Updated: Aprill 22, 2013</p> </td> </tr> </table> @@ -8632,7 +8632,7 @@ FAR void *mmap(FAR void *start, size_t length, int prot, int flags, int fd, off_ <p>NuttX includes a simple interface layer based on uIP (see <a href="http://www.sics.se/~adam/uip/index.php/Main_Page">http://www.sics.se</a>). NuttX supports subset of a standard socket interface to uIP. These network feature can be enabled by settings in the architecture -<a href="NuttxPortingGuide.html#apndxconfigs">configuration file</a>. +<a href="NuttXConfigVariables.html">configuration file</a>. Those socket APIs are discussed in the following paragraphs.</p> <ul> <li> |