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: <20250520095037.3dc39685@sal.lan>
Date: Tue, 20 May 2025 09:50:37 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: Jonathan Corbet <corbet@....net>, 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

Hi Randy,

Em Mon, 19 May 2025 22:55:08 -0700
Randy Dunlap <rdunlap@...radead.org> escreveu:

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

Well, on next-20250516:

	$ ls drivers/gpio/gpiolib-acpi.c
	ls: cannot access 'drivers/gpio/gpiolib-acpi.c': No such file or directory

Avoiding the script to abort is a matter of adding a try/except
block at kerneldoc.py, but I'd say that, if an include file (or any other
file needed for the build) is not found, "make" should abort anyway for
the affected target (Kernel compilation or when doc building).

The only thing that bothers me is the "Sphinx parallel build error!"
message. I'll check if there is a way to suppress it.

Regards,
Mauro