mirror of
https://github.com/apache/nuttx.git
synced 2026-05-12 01:42:49 +08:00
Matteo Golin
53fdfa68b9
All of the tools listed on the original documentation are now given their own individual doc pages. This makes it much easier to cross-reference them from other documentation locations (as many are used in CI/for specific architectures) and it also makes it easier for users to digest the information. Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
38 lines
1.1 KiB
ReStructuredText
38 lines
1.1 KiB
ReStructuredText
==================
|
|
``kconfig2html.c``
|
|
==================
|
|
|
|
This is a C file that can be used to build a utility for converting the
|
|
NuttX configuration in the Kconfig files to an HTML document. This
|
|
auto-generated documentation will, eventually, replace the manually
|
|
updated configuration documentation that is falling woefully behind:
|
|
|
|
.. code:: console
|
|
|
|
$ tools/kconfig2html.exe -h
|
|
USAGE: tools/kconfig2html [-d] [-a <apps directory>] {-o <out file>] [<Kconfig root>]
|
|
tools/kconfig2html [-h]
|
|
|
|
Where::
|
|
|
|
-a : Select relative path to the apps/ directory. This 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>: .
|
|
|
|
|
|
.. note::
|
|
|
|
In order to use this tool, some configuration must be in-place with
|
|
all necessary symbolic links. You can establish the configured symbolic
|
|
links with::
|
|
|
|
make context
|
|
|
|
or more quickly with::
|
|
|
|
make .dirlinks
|