Skip to content

RFC Add Kconfig pages and cross-references to Documentation

Nícolas F. R. A. Prado linux-doc linux-kbuild lkml oe-kbuild-all 1 version In review

Get series with b4
b4 am [email protected] change-id 20250403-kconfig-docs-19d90ba266dd

Versions newest first

  1. v1 RFC Latest2 patches 4 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/2docs: Add documentation generation for Kconfig symbolsDocumentation/.gitignore Documentation/Config/index.rst Documentation/Makefile +2 more+368 -11 reply
2/2docs: automarkup: Cross-reference CONFIG_ symbolsDocumentation/sphinx/automarkup.py+35 -10 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH RFC 0/2] Add Kconfig pages and cross-references to Documentation

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.

---
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,

Signature · 1 line
Nícolas F. R. A. Prado <[email protected]>