summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGregory Nutt <gnutt@nuttx.org>2013-04-22 17:36:27 -0600
committerGregory Nutt <gnutt@nuttx.org>2013-04-22 17:36:27 -0600
commit886e0bd14191864a39624a08595a19357c3fb2f5 (patch)
tree75d903968ee9fc3602630e52efead913d2d21416
parentfcf97cd5b2040c0c78d9e4ff627847b9d22584fe (diff)
downloadnuttx-886e0bd14191864a39624a08595a19357c3fb2f5.tar.gz
nuttx-886e0bd14191864a39624a08595a19357c3fb2f5.tar.bz2
nuttx-886e0bd14191864a39624a08595a19357c3fb2f5.zip
kconfig2html: A few minor things missed in the last commit
-rw-r--r--nuttx/configs/README.txt36
-rw-r--r--nuttx/tools/kconfig2html.c4
2 files changed, 26 insertions, 14 deletions
diff --git a/nuttx/configs/README.txt b/nuttx/configs/README.txt
index d4a74521c..3e1f22625 100644
--- a/nuttx/configs/README.txt
+++ b/nuttx/configs/README.txt
@@ -5,6 +5,7 @@ Table of Contents
o Board-Specific Configurations
o Summary of Files
+ o Configuration Variables
o Supported Architectures
o Configuring NuttX
o Building Symbol Tables
@@ -131,8 +132,29 @@ defconfig -- This is a configuration file similar to the Linux
(2) to generate include/nuttx/config.h which is included by
most C files in the system.
- The following variables are recognized by the build (you may
- also include architecture/board-specific settings).
+appconfig -- This is another configuration file that is specific to the
+ application. This file is copied into the application build directory
+ when NuttX is configured. See ../apps/README.txt for further details.
+
+setenv.sh -- This is a script that you can include that will be installed at
+ the toplevel of the directory structure and can be sourced to set any
+ necessary environment variables. You will most likely have to customize the
+ default setenv.sh script in order for it to work correctly in your
+ environment.
+
+Configuration Variables
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Note. This section is deprecated. Documentation of NuttX configuration is
+now provided in a separate, auto-generated Configuration Variable Document.
+That configuration variable document is generated using the kconfig2html
+tool. That tool analyzes the NuttX Kconfig 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 tools directory README
+file.
+
+The following variables are recognized by the build (you may also include
+architecture/board-specific settings).
Architecture selection:
@@ -1672,16 +1694,6 @@ defconfig -- This is a configuration file similar to the Linux
CONFIG_PTHREAD_STACK_MIN - Minimum pthread stack size
CONFIG_PTHREAD_STACK_DEFAULT - Default pthread stack size
-appconfig -- This is another configuration file that is specific to the
- application. This file is copied into the application build directory
- when NuttX is configured. See ../apps/README.txt for further details.
-
-setenv.sh -- This is a script that you can include that will be installed at
- the toplevel of the directory structure and can be sourced to set any
- necessary environment variables. You will most likely have to customize the
- default setenv.sh script in order for it to work correctly in your
- environment.
-
Supported Boards
^^^^^^^^^^^^^^^^
diff --git a/nuttx/tools/kconfig2html.c b/nuttx/tools/kconfig2html.c
index ce40ff40a..de749cb7d 100644
--- a/nuttx/tools/kconfig2html.c
+++ b/nuttx/tools/kconfig2html.c
@@ -1819,12 +1819,12 @@ static inline char *process_config(FILE *stream, const char *configname,
if (config.c_select.s_nvar > 0)
{
- outfunc(" <li><i>Selects</i>: <a href=\"#CONFIG_%s\">CONFIG_%s</a>",
+ outfunc(" <li><i>Selects</i>: <a href=\"#CONFIG_%s\"><code>CONFIG_%s</code></a>",
config.c_select.s_varname[0], config.c_select.s_varname[0]);
for (i = 1; i < config.c_select.s_nvar; i++)
{
- outfunc(", <a href=\"#CONFIG_%s\">CONFIG_%s</a>",
+ outfunc(", <a href=\"#CONFIG_%s\"><code>CONFIG_%s</code></a>",
config.c_select.s_varname[i], config.c_select.s_varname[i]);
}