From: "Nícolas F. R. A. Prado" <nfraprado@collabora.com>
To: Jonathan Corbet <corbet@lwn.net>,
Masahiro Yamada <masahiroy@kernel.org>,
Nathan Chancellor <nathan@kernel.org>,
Nicolas Schier <nicolas.schier@linux.dev>
Cc: kernel@collabora.com, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-kbuild@vger.kernel.org,
"Mauro Carvalho Chehab" <mchehab@kernel.org>,
"Nícolas F. R. A. Prado" <nfraprado@collabora.com>
Subject: [PATCH RFC 0/2] Add Kconfig pages and cross-references to Documentation
Date: Fri, 04 Apr 2025 10:02:51 -0400 [thread overview]
Message-ID: <20250404-kconfig-docs-v1-0-4c3155d4ba44@collabora.com> (raw)
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@collabora.com>
---
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@collabora.com>
next reply other threads:[~2025-04-04 14:03 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-04 14:02 Nícolas F. R. A. Prado [this message]
2025-04-04 14:02 ` [PATCH RFC 1/2] docs: Add documentation generation for Kconfig symbols Nícolas F. R. A. Prado
2025-04-07 2:47 ` Mauro Carvalho Chehab
2025-04-04 14:02 ` [PATCH RFC 2/2] docs: automarkup: Cross-reference CONFIG_ symbols Nícolas F. R. A. Prado
2025-04-04 14:31 ` [PATCH RFC 0/2] Add Kconfig pages and cross-references to Documentation Jonathan Corbet
2025-04-04 16:24 ` Nícolas F. R. A. Prado
2025-04-07 3:06 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250404-kconfig-docs-v1-0-4c3155d4ba44@collabora.com \
--to=nfraprado@collabora.com \
--cc=corbet@lwn.net \
--cc=kernel@collabora.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=masahiroy@kernel.org \
--cc=mchehab@kernel.org \
--cc=nathan@kernel.org \
--cc=nicolas.schier@linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox