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 v6 0/6] kernel-doc: add support for documenting vars
Date: Tue, 16 Dec 2025 15:19:22 +0100 [thread overview]
Message-ID: <cover.1765894670.git.mchehab+huawei@kernel.org> (raw)
Hi Jon,
As suggested and discussed with Randy, this small series add support
for documenting variables using kernel-doc.
- patch 1: add support for the new feature;
- patch 2: extends to support DEFINE_*;
- patch 3: document two media vars;
- patch 4: fix an issue on kernel-doc.rst markups and automarkup;
- patch 5: document it;
- patch 6: better handle DEFINE_ macros when they don't have static/type;
On this version, I'm using "c:macro" to describe variables, as it
avoids Sphinx C domain to try parse the variable. This makes it more
flexible and easier to maintain in long term.
Mauro Carvalho Chehab (6):
kernel-doc: add support for handling global variables
kernel-doc: add support to handle DEFINE_ variables
docs: media: v4l2-ioctl.h: document two global variables
docs: kernel-doc.rst: don't let automarkup mangle with consts
docs: kernel-doc.rst: document the new "var" kernel-doc markup
docs: kernel-doc.rst: Parse DEFINE_ macros without prefixes
Documentation/doc-guide/kernel-doc.rst | 48 +++++++++++-----
include/media/v4l2-ioctl.h | 15 +++++
tools/lib/python/kdoc/kdoc_output.py | 46 +++++++++++++++
tools/lib/python/kdoc/kdoc_parser.py | 79 +++++++++++++++++++++++++-
4 files changed, 172 insertions(+), 16 deletions(-)
--
2.52.0
next reply other threads:[~2025-12-16 14:19 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-16 14:19 Mauro Carvalho Chehab [this message]
2025-12-16 14:19 ` [PATCH v6 1/6] kernel-doc: add support for handling global variables Mauro Carvalho Chehab
2025-12-16 14:19 ` [PATCH v6 2/6] kernel-doc: add support to handle DEFINE_ variables Mauro Carvalho Chehab
2025-12-16 14:19 ` [PATCH v6 3/6] docs: media: v4l2-ioctl.h: document two global variables Mauro Carvalho Chehab
2025-12-16 14:19 ` [PATCH v6 4/6] docs: kernel-doc.rst: don't let automarkup mangle with consts Mauro Carvalho Chehab
2025-12-16 14:19 ` [PATCH v6 5/6] docs: kernel-doc.rst: document the new "var" kernel-doc markup Mauro Carvalho Chehab
2025-12-16 14:19 ` [PATCH v6 6/6] docs: kernel-doc.rst: Parse DEFINE_ macros without prefixes 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.1765894670.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.