lupyuen/local-nuttx-update
1
0
Fork 0
forked from nuttx/nuttx-update
Code Pull requests Activity

Documentation now expects autogenerated configuration variable documenation at Documentation/NuttXConfigVariables.html

Browse source
This commit is contained in:
Gregory Nutt 2013-04-22 16:46:15 -06:00
parent ba3f1a751d
commit cf311c82ab
7 changed files with 79 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
ChangeLog
View file

@ -4586,3 +4586,6 @@
Aimonen (2014-4-22).
* fs/fat/fs_writefat.c: mkfatfs was writing the boot code to the
wrong location. From Petteri Aimonen (2014-4-22).
* Documentation: The NuttX documentation now expects to find an
auto-generated version of the configuration variable documentation
at Documentation/NuttXConfigVariables.html (2014-4-22).

21
Documentation/NuttX.html
View file

@ -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.
@ -4175,6 +4175,10 @@ pascal-3.0 2011-05-15 Gregory Nutt &lt;gnutt@nuttx.org&gt;
<td valign="top" width="22"><img height="20" width="20" src="favicon.ico"></td>
<td><a href="NuttxPortingGuide.html">Porting Guide</a></td>
</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>
@ -4215,7 +4219,14 @@ pascal-3.0 2011-05-15 Gregory Nutt &lt;gnutt@nuttx.org&gt;
<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 &lt;gnutt@nuttx.org&gt;
</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 &lt;gnutt@nuttx.org&gt;
</body>
</html>

2
Documentation/NuttXDocumentation.html
View file

@ -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">

8
Documentation/NuttxPortingGuide.html
View file

@ -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>

4
Documentation/NuttxUserGuide.html
View file

@ -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>

21
tools/README.txt
View file

@ -90,6 +90,27 @@ kconfig2html.c
auto-generated documentation will, eventually, replace the manually
updated configuratin documentation that is fallling woefully behind.
USAGE: kconfig2html [-d] [-a <apps directory>] {-o <out file>] [<Kconfig root>]
kconfig2html [-h]
Where:
-a : Select relative path to the apps/ directory. Theis path is relative
to the <Kconfig directory>. Default: ../apps
-o : Send output to <out file>. Default: Output goes to stdout
-d : Enable debug output
-h : Prints this message and exits
<Kconfig root> is the directory containing the root Kconfig file.
Default <Kconfig directory>: .
mkconfigvars.sh
---------------
The HTML documentation expects to have a copy of the auto-generated
configuration variabled documentation Documentation/NuttXConfigVariables.html.
The script mkconfigvars.sh is a simple script that can be used to
re-generated that file as needed.
mkexport.sh and Makefile.export
-------------------------------

32
tools/kconfig2html.c
View file

@ -2520,15 +2520,30 @@ int main(int argc, char **argv, char **envp)
output("}\n");
output("</script>\n");
output("<center><h1>Table of contents</h1></center>\n");
output("<hr><hr>\n");
output("<table width =\"100%%\">\n");
output(" <tr bgcolor=\"#e4e4e4\">\n");
output(" <td>\n");
output(" <h1>Table of Contents</h1>\n");
output(" </td>\n");
output(" </tr>\n");
output("</table>\n");
output("<ul>\n");
incr_level();
paranum = get_paranum();
output("<li><a href=\"#menu_%d\">%s Menu: Main</a></li>\n",
g_menu_number, paranum);
body("<h1><a name=\"menu_%d\">%s Menu: Main</a></h1>\n",
body("<table width =\"100%%\">\n");
body(" <tr bgcolor=\"#e4e4e4\">\n");
body(" <td>\n");
body(" <a name=\"menu_%d\"><h1>%s Menu: Main</h1></a>\n",
g_menu_number, paranum);
body(" </td>\n");
body(" </tr>\n");
body("</table>\n");
g_menu_number++;
/* Increment the paragraph level again: Everything is included within the main menu. */
@ -2555,7 +2570,7 @@ int main(int argc, char **argv, char **envp)
body("<p>\n");
body(" <b>Mainenance Note</b>.\n");
body(" This documenation was auto-generated using the <a href=\"http://sourceforge.net/p/nuttx/git/ci/master/tree/nuttx/tools/kconfig2html.c\">kconfig2html</a> tool\n");
body(" That tools analyzes the NuttX <code>Kconfig</code> and generates this HTML document.\n");
body(" That tool analyzes the NuttX <code>Kconfig</code> files and generates this HTML document.\n");
body(" This HTML document file should not be editted manually.\n");
body(" In order to make changes to this document, you should instead modify the <code>Kconfig</code> file(s) that were used to generated this document and then execute the <code>kconfig2html</code> again to regenerate the HTML document file.\n");
body("</p>\n");
@ -2566,7 +2581,7 @@ int main(int argc, char **argv, char **envp)
/* Terminate the table of contents */
output("<li><a href=\"#appendixa\">Appendix A</a></li>\n");
output("<li><a href=\"#appendixa\">Appendix A: Hidden Configuration Variables</a></li>\n");
output("</ul>\n");
/* Close the HMTL body file and copy it to the output file */
@ -2576,7 +2591,14 @@ int main(int argc, char **argv, char **envp)
/* Output introductory information for the appendix */
output("<h1><a name=\"appendixa\">Appendix A</a></h1>\n");
output("<table width =\"100%%\">\n");
output(" <tr bgcolor=\"#e4e4e4\">\n");
output(" <td>\n");
output(" <a name=\"appendixa\"><h1>Appendix A: Hidden Configuration Variables</h1></a>\n");
output(" </td>\n");
output(" </tr>\n");
output("</table>\n");
output("<p>\n");
output(" This appendex holds internal configurations variables that are not visible to the user.\n");
output(" These settings are presented out-of-context because they cannot be directly controlled by the user.\n");