linux-kernel - Re: [PATCH 2/2] docs: conf.py: get rid of load

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: <87plbmqg0f.fsf@trenco.lwn.net>
Date: Fri, 19 Sep 2025 15:38:56 -0600
From: Jonathan Corbet <corbet@....net>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Linux Doc Mailing
 List <linux-doc@...r.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Mauro Carvalho Chehab
 <mchehab+huawei@...nel.org>, Kees Cook <mchehab+huawei@...nel.org>,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH 2/2] docs: conf.py: get rid of load_config.py

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

> The code here was meant to handle 3 functions:
> 1. allow having a separate conf.py file, per subdir;
> 2. generate a list of latex documents.
> 3. set "subproject" tag if SPHINXDIRS points to a subdir.
>
> We don't have (1) anymore, and (3) is now properly handled
> entirely inside conf.py.
>
> So, only (3) is still needed, and this is a single-line change
> at conf.py.
>
> So, drop it, moving the remaining code to conf.py.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
>  Documentation/Makefile              |  4 --
>  Documentation/conf.py               | 15 +++-----
>  Documentation/sphinx/load_config.py | 60 -----------------------------
>  3 files changed, 5 insertions(+), 74 deletions(-)
>  delete mode 100644 Documentation/sphinx/load_config.py
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 6ccd5db1dcbd..9663e7a31feb 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -24,7 +24,6 @@ SPHINXDIRS    = .
>  DOCS_THEME    =
>  DOCS_CSS      =
>  RUSTDOC       =
> -SPHINX_CONF   = conf.py
>  PAPER         =
>  BUILDDIR      = $(obj)/output
>  PDFLATEX      = xelatex
> @@ -108,9 +107,6 @@ dochelp:
>  	@echo  '  make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
>  	@echo  '  valid values for SPHINXDIRS are: $(_SPHINXDIRS)'
>  	@echo
> -	@echo  '  make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'
> -	@echo  '  configuration. This is e.g. useful to build with nit-picking config.'
> -	@echo
>  	@echo  '  make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'

So probably I'm a little slow today, but this confuses me.  Even after
this change, the makefile still uses SPHINX_CONF, so I'm not sure how it
is supposed to be set?

Thanks,

jon