linux-kernel - Re: [PATCH 0/9] docs: Fix kernel-doc -Werror and moves it to tools/docs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87wm1bhozz.fsf@trenco.lwn.net>
Date: Tue, 20 Jan 2026 15:56:48 -0700
From: Jonathan Corbet <corbet@....net>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Alex Shi
 <alexs@...nel.org>, Carlos Bilbao <carlos.bilbao@...nel.org>, David Airlie
 <airlied@...il.com>, Federico Vaga <federico.vaga@...a.pv.it>, Hu Haowen
 <2023002089@...k.tyut.edu.cn>, Jani Nikula <jani.nikula@...ux.intel.com>,
 Joonas Lahtinen <joonas.lahtinen@...ux.intel.com>, Mauro Carvalho Chehab
 <mchehab@...nel.org>, Nathan Chancellor <nathan@...nel.org>, Nicolas
 Schier <nsc@...nel.org>, Rodrigo Vivi <rodrigo.vivi@...el.com>, Simona
 Vetter <simona@...ll.ch>, Tvrtko Ursulin <tursulin@...ulin.net>, Yanteng
 Si <si.yanteng@...ux.dev>, dri-devel@...ts.freedesktop.org,
 intel-gfx@...ts.freedesktop.org, linux-doc@...r.kernel.org,
 linux-kbuild@...r.kernel.org, linux-kernel@...r.kernel.org,
 workflows@...r.kernel.org, Thomas Weißschuh
 <thomas.weissschuh@...utronix.de>, Andy Shevchenko
 <andriy.shevchenko@...ux.intel.com>, Avadhut Naik <avadhut.naik@....com>,
 Chenguang Zhao <zhaochenguang@...inos.cn>, David Disseldorp
 <ddiss@...e.de>, Dongliang Mu <dzm91@...t.edu.cn>, Gang Yan
 <yangang@...inos.cn>, Kees Cook <kees@...nel.org>, Masahiro Yamada
 <masahiroy@...nel.org>, Miguel Ojeda <ojeda@...nel.org>, Randy Dunlap
 <rdunlap@...radead.org>, Shuah Khan <skhan@...uxfoundation.org>, Steven
 Rostedt <rostedt@...dmis.org>, Tamir Duberstein <tamird@...il.com>,
 Vincent Mailhol <mailhol@...nel.org>, WangYuli <wanyl5933@...naunicom.cn>
Subject: Re: [PATCH 0/9] docs: Fix kernel-doc -Werror and moves it to
 tools/docs

Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:

> Hi Jon,
>
> After a restful weekend and revisiting both yours and my series,
> I'm opting to send a patch series merging both into one:
>
> - The first 4 patches are from my series (no changes since v5):
>     https://lore.kernel.org/linux-doc/cover.1768642102.git.mchehab+huawei@kernel.org/T/#m81211c0ff38bbaa82b8b0b6606f242ccc0c2a9ac
>
> - It follows by the 2 patches from your renaming series:
>     https://lore.kernel.org/linux-doc/20260119111745.4694546b@foz.lan/T/#m51099c31a99dccccdb4d17cbaadc818e9e4df8c4
>
>   with the fix I proposed for kernel-doc to find its libraries
>
> I added 3 patches afterwards:
>
>   - patch 5: move possible return values from docstring to helper message;
>   - patch 6: improve MsgFormatter description;
>   - patch 7: moves kerneldoc_bin from conf.py to the sphinx/kerneldoc.py
>     (this is now just a debugging message - no need to pick it from env)
>
> IMO, this series is ready to be merged.

Patch 7 adds a new warning:

  WARNING: unknown config value 'kerneldoc_bin' in override, ignoring

It needs to be taken out of sphinx-build-wrapper; I've appended the
following patch to the series to deal with it.  I think I'll go ahead
and tack on a patch putting in the scripts/kernel-doc symlink, then I
guess it's ready to go.

Thanks,

jon

>From 4a3efd128f7da996b677151790d043ec44a00561 Mon Sep 17 00:00:00 2001
From: Jonathan Corbet <corbet@....net>
Date: Tue, 20 Jan 2026 15:50:38 -0700
Subject: [PATCH] docs: sphinx-build-wrapper: stop setting kerneldoc_bin for
 Sphinx

Now that the Sphinx build does not use the kerneldoc_bin configuration
variable, we shouldn't try to set it in the build wrapper or we get a nifty
warning:

  WARNING: unknown config value 'kerneldoc_bin' in override, ignoring

Signed-off-by: Jonathan Corbet <corbet@....net>
---
 tools/docs/sphinx-build-wrapper | 1 -
 1 file changed, 1 deletion(-)

diff --git a/tools/docs/sphinx-build-wrapper b/tools/docs/sphinx-build-wrapper
index cb2a5005e633..9f1ae1485f84 100755
--- a/tools/docs/sphinx-build-wrapper
+++ b/tools/docs/sphinx-build-wrapper
@@ -750,7 +750,6 @@ class SphinxBuilder:
 
             build_args = args + [
                 "-d", doctree_dir,
-                "-D", f"kerneldoc_bin={kerneldoc}",
                 "-D", f"version={self.kernelversion}",
                 "-D", f"release={self.kernelrelease}",
                 "-D", f"kerneldoc_srctree={self.srctree}",
-- 
2.52.0