linux-kernel - Re: [PATCH 1/1] docs: kerneldoc.py: don't use Sphinx logger

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: <7bbe75ff-548f-4ffd-9522-59d1518d6c72@infradead.org>
Date: Mon, 19 May 2025 22:55:08 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
 Jonathan Corbet <corbet@....net>
Cc: Akira Yokosawa <akiyks@...il.com>,
 Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
 Nicolas Schier <nicolas.schier@...ux.dev>,
 Stephen Rothwell <sfr@...b.auug.org.au>, linux-doc@...r.kernel.org,
 linux-kbuild@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 1/1] docs: kerneldoc.py: don't use Sphinx logger



On 5/19/25 10:47 PM, Mauro Carvalho Chehab wrote:
> Unfortunately, currently Sphinx logger is suppressing too much, not
> allowing warnings to be displayed. Disable it.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

On linux-next-20250516, this gives me:

Cannot find file ../drivers/gpio/gpiolib-acpi.c
Cannot find file ../drivers/gpio/gpiolib-acpi.c
...
Sphinx parallel build error!

Versions
========

* Platform:         linux; (Linux-6.14.4-1-default-x86_64-with-glibc2.41)
* Python version:   3.13.3 (CPython)
* Sphinx version:   8.2.3
* Docutils version: 0.21.2
* Jinja2 version:   3.1.6
* Pygments version: 2.19.1

Last Messages
=============


    reading sources... [ 75%]
    translations/it_IT/subsystem-apis .. translations/zh_CN/admin-guide/mm/damon/reclaim

    reading sources... [ 77%]
    translations/zh_CN/admin-guide/mm/damon/start .. translations/zh_CN/core-api/symbol-namespaces

    reading sources... [ 79%]
    translations/zh_CN/core-api/this_cpu_ops .. translations/zh_CN/kernel-hacking/index

Loaded Extensions
=================

* sphinx.ext.mathjax (8.2.3)
* alabaster (1.0.0)
* sphinxcontrib.applehelp (2.0.0)
* sphinxcontrib.devhelp (1.0.6)
* sphinxcontrib.htmlhelp (2.1.0)
* sphinxcontrib.serializinghtml (1.1.10)
* sphinxcontrib.qthelp (2.0.0)
* kerneldoc (1.0)
* rstFlatTable (1.0)
* kernel_include (1.0)
* kfigure (1.0.0)
* sphinx.ext.ifconfig (8.2.3)
* automarkup (unknown version)
* maintainers_include (1.0)
* sphinx.ext.autosectionlabel (8.2.3)
* kernel_abi (1.0)
* kernel_feat (1.0)
* translations (unknown version)

Traceback
=========

      File "/usr/lib/python3.13/site-packages/sphinx/util/parallel.py", line 137, in _join_one
        raise SphinxParallelError(*result)
    sphinx.errors.SphinxParallelError: KeyError: '../drivers/gpio/gpiolib-acpi.c'

and then it's finished (not a normal finish).
So IMHO this patch is not sufficient.


> ---
>  Documentation/sphinx/kerneldoc.py | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py
> index b713a2c4a615..314479718a01 100644
> --- a/Documentation/sphinx/kerneldoc.py
> +++ b/Documentation/sphinx/kerneldoc.py
> @@ -311,7 +311,11 @@ def setup_kfiles(app):
>      if kerneldoc_bin and kerneldoc_bin.endswith("kernel-doc.py"):
>          print("Using Python kernel-doc")
>          out_style = RestFormat()
> -        kfiles = KernelFiles(out_style=out_style, logger=logger)
> +
> +        # Ideally, we should be using Sphinx logger here, but its filtering
> +        # rules ending filtering out warnings and errors. So, let's use
> +        # Python default logger instead.
> +        kfiles = KernelFiles(out_style=out_style)
>      else:
>          print(f"Using {kerneldoc_bin}")
>  

-- 
~Randy