[PATCH 0/3] Some kernel-doc fixes

Mauro Carvalho Chehab posted 3 patches 1 week, 3 days ago
There is a newer version of this series
tools/docs/sphinx-build-wrapper  | 42 +++++++++++++++++++++++++++-----
tools/lib/python/kdoc/kdoc_re.py | 10 +++++---
2 files changed, 43 insertions(+), 9 deletions(-)
[PATCH 0/3] Some kernel-doc fixes
Posted by Mauro Carvalho Chehab 1 week, 3 days ago
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(-)

-- 
2.52.0
Re: [PATCH 0/3] Some kernel-doc fixes
Posted by Jonathan Corbet 4 days, 12 hours ago
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> 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(-)

I've applied this set, thanks.

jon
Re: [PATCH 0/3] Some kernel-doc fixes
Posted by Jonathan Corbet 1 week, 3 days ago
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

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

6.21?  I'm kind of assuming you mean the *next* cycle, which will be
7.0?

Thanks,

jon