linux-kernel - Re: [PATCH v2 3/3] tools/docs: sphinx-* break documentation bulds on openSUSE

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: <76c552d4-878f-4ec4-a22c-c5b0f7903eba@infradead.org>
Date: Wed, 3 Sep 2025 10:41:12 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
 Jonathan Corbet <corbet@....net>,
 Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc: Björn Roy Baron <bjorn3_gh@...tonmail.com>,
 Alex Gaynor <alex.gaynor@...il.com>, Alice Ryhl <aliceryhl@...gle.com>,
 Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>,
 Trevor Gross <tmgross@...ch.edu>, linux-kernel@...r.kernel.org,
 rust-for-linux@...r.kernel.org
Subject: Re: [PATCH v2 3/3] tools/docs: sphinx-* break documentation bulds on
 openSUSE



On 9/3/25 9:24 AM, Mauro Carvalho Chehab wrote:
> Before this patch, building htmldocs on opensuseLEAP works
> fine:
> 
>     # make htmldocs
>     Available Python versions:
>       /usr/bin/python3.11
> 
>     Python 3.6.15 not supported. Changing to /usr/bin/python3.11
>     Python 3.6.15 not supported. Changing to /usr/bin/python3.11
>     Using alabaster theme
>     Using Python kernel-doc
> 
>     ...
> 
> As the logic detects that Python 3.6 is too old and recommends
> intalling python311-Sphinx. If installed, documentation builds
> work like a charm.
> 
> Yet, some develpers complained that running python3.11 instead
> of python3 should not happen. So, let's break the build to make
> them happier:
> 
>     $ make htmldocs
>     Python 3.6.15 not supported. Bailing out
>     You could run, instead:
>       /usr/bin/python3.11 /root/tools/docs/sphinx-build-wrapper htmldocs --sphinxdirs=. --conf=conf.py --theme= --css= --paper=

                            /root
??

> 
>     Python 3.6.15 not supported. Bailing out
>     make[2]: *** [Documentation/Makefile:75: htmldocs] Error 1
>     make[1]: *** [/root/Makefile:1806: htmldocs] Error 2
>     make: *** [Makefile:248: __sub-make] Error 2
> 
> It should be noticed that:
> 
> 1. after this change, sphinx-pre-install needs to be called
>    by hand:
> 
>     $ /usr/bin/python3.11 tools/docs/sphinx-pre-install
>     Detected OS: openSUSE Leap 15.6.
>     Sphinx version: 7.2.6
> 
>     All optional dependencies are met.
>     Needed package dependencies are met.
> 
> 2. sphinx-build-wrapper will auto-detect python3.11 and
>    suggest a way to build the docs using the parameters passed
>    via make variables. In this specific example:
> 
>    /usr/bin/python3.11 /root/tools/docs/sphinx-build-wrapper htmldocs --sphinxdirs=. --conf=conf.py --theme= --css= --paper=

ditto.

> 
> 3. As this needs to be executed outside docs Makefile, it won't run
>    the validation check scripts nor build Rust documentation if
>    enabled, as the extra scripts are part of the docs Makefile.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
>  tools/docs/sphinx-build-wrapper | 3 ++-
>  tools/docs/sphinx-pre-install   | 3 ++-
>  2 files changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/tools/docs/sphinx-build-wrapper b/tools/docs/sphinx-build-wrapper
> index 932b1b675274..48e6e0a76aeb 100755
> --- a/tools/docs/sphinx-build-wrapper
> +++ b/tools/docs/sphinx-build-wrapper
> @@ -719,7 +719,8 @@ def main():
>  
>      args = parser.parse_args()
>  
> -    PythonVersion.check_python(MIN_PYTHON_VERSION)
> +    PythonVersion.check_python(MIN_PYTHON_VERSION, show_alternatives=True,
> +                               bail_out=True)
>  
>      builder = SphinxBuilder(venv=args.venv, verbose=args.verbose,
>                              n_jobs=args.jobs, interactive=args.interactive)
> diff --git a/tools/docs/sphinx-pre-install b/tools/docs/sphinx-pre-install
> index 663d4e2a3f57..698989584b6a 100755
> --- a/tools/docs/sphinx-pre-install
> +++ b/tools/docs/sphinx-pre-install
> @@ -1531,7 +1531,8 @@ def main():
>  
>      checker = SphinxDependencyChecker(args)
>  
> -    PythonVersion.check_python(MIN_PYTHON_VERSION)
> +    PythonVersion.check_python(MIN_PYTHON_VERSION,
> +                               bail_out=True, success_on_error=True)
>      checker.check_needs()
>  
>  # Call main if not used as module

-- 
~Randy