Skip to content

Some kernel-doc fixes

Mauro Carvalho Chehab linux-doc lkml 1 version Applied

Status from this message: I've applied this set, thanks.

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest3 patches 6 repliesApplied

Patches in v1 Applied

#Subject and filesSizeRepliesApplied
1/3docs: kdoc: Fix pdfdocs build for toolstools/lib/python/kdoc/kdoc_re.py+7 -30 replies
2/3docs: sphinx-build-wrapper: allow -v override -qtools/docs/sphinx-build-wrapper+11 -30 replies
3/3tools: sphinx-build-wrapper: improve its help messagetools/docs/sphinx-build-wrapper+25 -30 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/3] Some kernel-doc fixes

Hi Jon,

This small series contain 3 patches:
- patch 1 fixes PDF docs build, as reported by Akira; (I'm resending this one as-is from its v2)
- patch 2 addresses a complain from Jani about not being able of disabling "-q" flag when building docs with V=0;
- patch 3 addresses an issue indirectly reported by Jani that it the env vars that affects the wrapper aren't documented.

With regards to patch 2, docs build honours V=0 by adding a "-q" flag.

When V=1 is set, there are two effects in place:

1. sphix-build will be called without "-q";
2. Sphinx extensions will increase their verbosity levels.

Sometimes, it is desired to just remove "-q" without increasing extensions verbosity. That's what patch 2 does.

IMO, at least patch 1 should be merged during Kernel v6.21 development cycle.

Mauro Carvalho Chehab (3):
docs: kdoc: Fix pdfdocs build for tools
docs: sphinx-build-wrapper: allow -v override -q
tools: sphinx-build-wrapper: improve its help message

 tools/docs/sphinx-build-wrapper  | 42 +++++++++++++++++++++++++++-----
 tools/lib/python/kdoc/kdoc_re.py | 10 +++++---
 2 files changed, 43 insertions(+), 9 deletions(-)
Signature · 1 line
2.52.0