From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
linux-kbuild@vger.kernel.org
Subject: [PATCH 0/1] add a make target to generate man pages from kernel-doc
Date: Tue, 26 Aug 2025 15:49:03 +0200 [thread overview]
Message-ID: <cover.1756215924.git.mchehab+huawei@kernel.org> (raw)
Currently, generation of manpages is hacky: one needs to run
kernel-doc over c source files and then use an extra script to
split results.
The new kernel-doc tool supports multiple files and even dirs,
so there's no need to use git ls-files anymore.
Yet, it produces a single output. Change the logic to add, instead
a target to docs Makefile to produce them, moving the split
and build logic to sphinx-build-wrapper.
That allows honoring SPHINXDIRS when they point to a subdir,
while scanning all files by default.
This series comes after:
https://lore.kernel.org/linux-doc/cover.1756138805.git.mchehab+huawei@kernel.org/T/#t
Mauro Carvalho Chehab (1):
docs: add support to build manpages from kerneldoc output
Documentation/Makefile | 3 +-
Documentation/doc-guide/kernel-doc.rst | 19 ++-----
Makefile | 2 +-
scripts/split-man.pl | 28 ----------
tools/docs/sphinx-build-wrapper | 77 ++++++++++++++++++++++++--
5 files changed, 80 insertions(+), 49 deletions(-)
delete mode 100755 scripts/split-man.pl
--
2.51.0
next reply other threads:[~2025-08-26 13:49 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-26 13:49 Mauro Carvalho Chehab [this message]
2025-08-26 13:49 ` [PATCH 1/1] docs: add support to build manpages from kerneldoc output 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.1756215924.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.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;
as well as URLs for NNTP newsgroup(s).