This series adds Kconfig pages (patch 1) to the Documentation, and
automarkups CONFIG_* text as cross-references to those pages (patch 2).
There is a huge change in build time with this series, so we'd either
have to so some optimization and/or put this behind a flag in make so it
is only generated when desired (for instance for the online
documentation):
(On an XPS 13 9300)
Before:
real 6m43.576s
user 23m32.611s
sys 1m48.220s
After:
real 11m56.845s
user 47m40.528s
sys 2m27.382s
There are also some issues that were solved in ad-hoc ways (eg the
sphinx warnings due to repeated Kconfigs, by embedding the list of
repeated configs in the script). Hence the RFC.
Signed-off-by: Nícolas F. R. A. Prado <nfraprado@xxxxxxxxxxxxx>
---
Nícolas F. R. A. Prado (2):
docs: Add documentation generation for Kconfig symbols
docs: automarkup: Cross-reference CONFIG_ symbols
Documentation/.gitignore | 2 +
Documentation/Config/index.rst | 17 ++
Documentation/Makefile | 12 +-
Documentation/kbuild/index.rst | 2 +
Documentation/sphinx/automarkup.py | 36 +++-
scripts/kconfig2rst.py | 336 +++++++++++++++++++++++++++++++++++++
6 files changed, 403 insertions(+), 2 deletions(-)
---
base-commit: 405e2241def89c88f008dcb899eb5b6d4be8b43c
change-id: 20250403-kconfig-docs-19d90ba266dd
Best regards,
--
Nícolas F. R. A. Prado <nfraprado@xxxxxxxxxxxxx>
