From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org,
Randy Dunlap <rdunlap@infradead.org>
Subject: [PATCH 00/14] kernel-doc: make it parse new functions and structs
Date: Tue, 27 Jan 2026 11:13:19 +0100 [thread overview]
Message-ID: <cover.1769508371.git.mchehab+huawei@kernel.org> (raw)
There are some patches at linux-next improving support and documentation
for context analysis. Those adds a new set of macros that are not
supported by the pure C Sphinx parser.
Add support by them, extending the usage of NestedMatch to cover more
complex macros.
This series is more complex than originally planned, as we found
a couple of hidden bugs at kernel-doc.
The series were co-developed with Randy, with came up with the
original patch. I ended helping identifying kernel-doc issues and
doing some changes to make the parser more reliable.
At least on my machine, by applying this patch and asking
kernel-doc to parse the entire Kernel tree reduced the
time from 36 seconds to 35 seconds, so it actually made it
a little bit faster.
It should now be possible to document all sorts of function
macros, as one of the bugs is that we were replacing macros
with blank strings, due to the incorrect usage of function_xforms.
Mauro Carvalho Chehab (12):
docs: kdoc_re: add support for groups()
docs: kdoc_re: don't go past the end of a line
docs: kdoc_parser: move var transformers to the beginning
docs: kdoc_parser: don't mangle with function defines
docs: kdoc_parser: add functions support for NestedMatch
docs: kdoc_parser: use NestedMatch to handle __attribute__ on
functions
docs: kdoc_parser: fix variable regexes to work with size_t
docs: kdoc_parser: fix the default_value logic for variables
docs: kdoc_parser: add some debug for variable parsing
docs: kdoc_parser: don't exclude defaults from prototype
docs: kdoc_parser: fix parser to support multi-word types
docs: kdoc_parser: add support for LIST_HEAD
Randy Dunlap (2):
docs: kdoc_parser: ignore context analysis and lock attributes
kdoc_parser: handle struct member macro VIRTIO_DECLARE_FEATURES(name)
tools/lib/python/kdoc/kdoc_parser.py | 103 +++++++++++++++++++--------
tools/lib/python/kdoc/kdoc_re.py | 9 ++-
2 files changed, 81 insertions(+), 31 deletions(-)
--
2.52.0
next reply other threads:[~2026-01-27 10:13 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-27 10:13 Mauro Carvalho Chehab [this message]
2026-01-27 10:13 ` [PATCH 01/14] docs: kdoc_re: add support for groups() Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 02/14] docs: kdoc_re: don't go past the end of a line Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 03/14] docs: kdoc_parser: move var transformers to the beginning Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 04/14] docs: kdoc_parser: don't mangle with function defines Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 05/14] docs: kdoc_parser: add functions support for NestedMatch Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 06/14] docs: kdoc_parser: use NestedMatch to handle __attribute__ on functions Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 07/14] docs: kdoc_parser: fix variable regexes to work with size_t Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 08/14] docs: kdoc_parser: fix the default_value logic for variables Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 09/14] docs: kdoc_parser: add some debug for variable parsing Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 10/14] docs: kdoc_parser: don't exclude defaults from prototype Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 11/14] docs: kdoc_parser: fix parser to support multi-word types Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 12/14] docs: kdoc_parser: ignore context analysis and lock attributes Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 13/14] docs: kdoc_parser: add support for LIST_HEAD Mauro Carvalho Chehab
2026-01-27 10:13 ` [PATCH 14/14] kdoc_parser: handle struct member macro VIRTIO_DECLARE_FEATURES(name) 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=cover.1769508371.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
/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