Files
nuttx/Documentation/components/tools/mkconfigvars.rst
T
Matteo Golin 53fdfa68b9 docs/components/tools: Give tools their own doc pages
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>
2026-03-05 18:12:54 +01:00

28 lines
742 B
ReStructuredText

===================
``mkconfigvars.sh``
===================
The HTML documentation expects to have a copy of the auto-generated
configuration variable documentation Documentation/NuttXConfigVariables.html.
The script mkconfigvars.sh is a simple script that can be used to
re-generated that file as needed.
Help:
.. code:: console
$ tools/mkconfigvars.sh -h
tools/mkconfigvars.sh is a tool for generation of configuration variable documentation
USAGE: tools/mkconfigvars.sh [-d|h] [-v <major.minor.patch>]
Where::
-v <major.minor.patch>
The NuttX version number expressed as a major, minor and patch number separated
by a period
-d
Enable script debug
-h
show this help message and exit