lwn.git/tools/docs/kernel-doc, branch masterLinux kernel documentation tree maintained by Jonathan Corbethttp://mirrors.hust.edu.cn/git/lwn.git/atom?h=master2026-03-22T21:10:40+00:00docs: kernel-doc: add support to store output on a YAML file2026-03-22T21:10:40+00:00Mauro Carvalho Chehabmchehab+huawei@kernel.org2026-03-18T09:11:14+00:00urn:sha1:01d6d7bf9672f1aeabbffaa3fbfb8017223ff878
Add a command line parameter and library support to optionally
store:
- KdocItem intermediate format after parsing;
- man pages output;
- rst output.
inside a YAML file.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <ba54277b3c909867153b9547dfa33c1831ca35d9.1773823995.git.mchehab+huawei@kernel.org>
docs: kdoc_output: pick a better default for modulename2026-03-09T16:34:38+00:00Mauro Carvalho Chehabmchehab+huawei@kernel.org2026-03-06T15:45:47+00:00urn:sha1:e4dadcf510da846f32aaaad5d5988890cbf6033d
Instead of placing the same data for modulename for all generated
man pages, use the directory from the filename used to produce
kernel docs as basis.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <8a5d91c93c0b9b34c2f60e389f4464742804d0d6.1772810752.git.mchehab+huawei@kernel.org>
docs: kdoc: improve description of MsgFormatter2026-01-20T22:31:06+00:00Mauro Carvalho Chehabmchehab+huawei@kernel.org2026-01-19T12:05:03+00:00urn:sha1:35c0f975ef4a96cb488bcb5fca6e852fc347bc49
The description there is quite vague. Make it clearer.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <94269990e2d665bec08a1b6f4d28d84939cb9d83.1768823489.git.mchehab+huawei@kernel.org>
docs: kdoc: move the return values to the helper message2026-01-20T22:31:06+00:00Mauro Carvalho Chehabmchehab+huawei@kernel.org2026-01-19T12:05:02+00:00urn:sha1:32e9a42440a230b14c438099bc5fccb5012a638a
It makes sense to describe what kernel-doc is expected to return
on its help message. Move such messages to argparse epilog.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <3bcfa48016770929fcd073376515e3ff0b777ea8.1768823489.git.mchehab+huawei@kernel.org>
docs: kdoc: move kernel-doc to tools/docs2026-01-20T22:31:06+00:00Jonathan Corbetcorbet@lwn.net2026-01-19T12:05:01+00:00urn:sha1:eba6ffd126cd52358181ed5a179644a161f9c65f
kernel-doc is the last documentation-related tool still living outside of
the tools/docs directory; the time has come to move it over.
[mchehab: fixed kdoc lib location]
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <311d17e403524349940a8b12de6b5e91e554b1f4.1768823489.git.mchehab+huawei@kernel.org>