kernel/git/stable/linux.git/tools/docs, branch master

doc tools: fix 'path' typos

2026-08-11T16:43:16+00:00

Correct "patch" or "patches" to "path" or "paths" in comments. Signed-off-by: Randy Dunlap Signed-off-by: Jonathan Corbet Message-ID: <20260806055634.1293294-1-rdunlap@infradead.org>

docs: sphinx-build-wrapper: include localversion in kernel version string

2026-08-11T15:44:20+00:00

Add any localversion* text to the kernel version string so that the docs index (home) page accurately indicates what the docs build version is. E.g.: 7.2.0-rc6-next-20260807 Signed-off-by: Randy Dunlap Signed-off-by: Jonathan Corbet Message-ID: <20260808045331.326769-1-rdunlap@infradead.org>

docs: kdoc_diff: add a helper tool to help checking kdoc regressions

2026-03-30T16:54:13+00:00

Checking for regressions at kernel-doc can be hard. Add a helper tool to make such task easier. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <24b3116a78348b13a74d1ff5e141160ef9705dd3.1774551940.git.mchehab+huawei@kernel.org>

doc tools: better handle KBUILD_VERBOSE

2026-03-30T16:03:40+00:00

As reported by Jacob, there are troubles when KBUILD_VERBOSE is set at the environment. Fix it on both kernel-doc and sphinx-build-wrapper. Reported-by: Jacob Keller Closes: https://lore.kernel.org/linux-doc/9367d899-53af-4d9c-9320-22fc4dbadca5@intel.com/ Signed-off-by: Mauro Carvalho Chehab Tested-by: Jacob Keller Signed-off-by: Jonathan Corbet Message-ID: <7a99788db75630fb14828d612c0fd77c45ec1891.1774591065.git.mchehab+huawei@kernel.org>

docs: kernel-doc: add support to store output on a YAML file

2026-03-22T21:10:40+00:00

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 Signed-off-by: Jonathan Corbet Message-ID:

tools/docs/checktransupdate.py: fix all issues reported by pylint

2026-03-22T20:55:21+00:00

This patch fixes all issues reported by pylint, including: 1. Format issue in logging. 2. Variable name style issue. Fixes: 63e96ce050e5 ("scripts: fix all issues reported by pylint") Signed-off-by: Haoyang LIU Signed-off-by: Jonathan Corbet Message-ID: <20260309074716.10739-1-tttturtleruss@gmail.com>

docs: kdoc_output: pick a better default for modulename

2026-03-09T16:34:38+00:00

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 Signed-off-by: Jonathan Corbet Message-ID: <8a5d91c93c0b9b34c2f60e389f4464742804d0d6.1772810752.git.mchehab+huawei@kernel.org>

docs: kdoc_output: fix naming for DOC markups

2026-03-09T16:34:38+00:00

Right now, DOC markups aren't being handled properly, as it was using the same name for all output. Fix it by filling the title argument on a different way. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <11d809e5c4bec23240d3ace3f342dbb2a9263446.1772810752.git.mchehab+huawei@kernel.org>

docs: sphinx-build-wrapper: don't allow "/" on file names

2026-03-09T16:34:38+00:00

When handling "DOC:" sections, slash characters may be there. Prevent using it at the file names, as this is used for directory separator. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID:

docs: sphinx-build-wrapper: better handle troff .TH markups

2026-03-09T16:34:38+00:00

Using a regular expression to match .TH is problematic, as it doesn't handle well quotation marks. Use shlex instead. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <9436806316d33aaf68625c00ce068463d3917660.1772810752.git.mchehab+huawei@kernel.org>