linux-stable.git/tools/docs/sphinx-build-wrapper, 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>

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: 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>

tools: sphinx-build-wrapper: improve its help message

2026-02-02T16:57:46+00:00

Besides the parameters that are passed via command line arguments,
the wrapper's behavior is affected by several environment variables.

Document that. While here, use __doc__ for its description.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet 
Message-ID:

docs: sphinx-build-wrapper: allow -v override -q

2026-02-02T16:57:46+00:00

Documentation builds were using "-q" for a long time, but sometimes
it is nice to see the Sphinx progress, without increasing build
verbosity - which would also turn on kernel-doc verbosity.

Instead of doing that, let's parse the sphinx-build already-existing
-v: each time it is used, it increases the verbosity level.

With that, if the default is to use -q, a single -v will disable
quiet mode. Passing more -v will keep increasing its verbosity.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet 
Message-ID: <38b24e97a3cbd2def418359a8e69b1b087a945ad.1769500383.git.mchehab+huawei@kernel.org>

tools/docs: sphinx-build-wrapper: only generate rust docs when requested

2026-01-23T18:27:22+00:00

When the user explicitly specifies SPHINXDIRS to build a specific
subdirectory it is unexpected that the rust docs are also generated.
Especially as their generation may dominate the execution time.

Only generate the rust docs when they are part of the SPHINXDIRS
requested by the user. 'rust/rustdocs' is not considered, as it is
not a valid SPHINXDIRS anyways.

Signed-off-by: Thomas Weißschuh 
Reviewed-by: Mauro Carvalho Chehab 
Tested-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet 
Message-ID: <20260118-docs-spurious-rust-v1-4-998e14b9ed9e@weissschuh.net>

tools/docs: sphinx-build-wrapper: compute sphinxdirs_list earlier

2026-01-23T18:27:22+00:00

An upcoming patch will require sphinxdirs_list to be available before
the call to check_rust().

Move it up in the function.

Signed-off-by: Thomas Weißschuh 
Reviewed-by: Mauro Carvalho Chehab 
Tested-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet 
Message-ID: <20260118-docs-spurious-rust-v1-3-998e14b9ed9e@weissschuh.net>