michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add brief description for Kconfig in the reference

Browse source 
Change-Id: I8ba54feb9d684945177c7ecfb08255aaf796734f
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2016-02-09 07:46:59 -05:00 • committed by Gerrit Code Review
commit df8db31f53
1 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/scripts/genrest/genrest.py
View file

@ -57,8 +57,24 @@ f.write(""".. _configuration:
Configuration Options Reference Guide
#####################################
The configuration options' information is extracted directly from :program:`Kconfig` using the
:file:`~/doc/scripts/genrest/genrest.py` script.
Introduction
************
Kconfig files describe the configuration symbols supported in the build
system, the logical organization and structure that group the symbols in menus
and sub-menus, and the relationships between the different configuration
symbols that govern the valid configuration combinations.
The Kconfig files are distributed across the build directory tree. The files
are organized based on their common characteristics and on what new symbols
they add to the configuration menus.
The configuration options' information is extracted directly from :program:`Kconfig`
using the :file:`~/doc/scripts/genrest/genrest.py` script.
Supported Options
*****************
""")
f.write(".. toctree::\n :maxdepth: 2\n\n")