linux-kernel - Re: [PATCH] docs: Makefile: update SPHINXDIRS documentation

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] [day] [month] [year] [list]

Message-ID: <874iqxucku.fsf@trenco.lwn.net>
Date: Thu, 13 Nov 2025 09:22:41 -0700
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>, Jani Nikula
 <jani.nikula@...el.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: Makefile: update SPHINXDIRS documentation

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

> Since the beginning, SPHINXDIRS was meant to be used by any
> subdirectory inside Documentation/ that contains a file named
> index.rst on it. The typical usecase for SPHINXDIRS is help
> building subsystem-specific documentation, without needing to
> wait for the entire building (with can take 3 minutes with
> Sphinx 8.x and above, and a lot more with older versions).
>
> Yet, the documentation for such feature was written back in
> 2016, where almost all index.rst files were at the first
> level (Documentation/*/index.rst).
>
> Update the documentation to reflect the way it works.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
>  Documentation/Makefile | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index d514ab6761dc..c66df29cf0a3 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -104,7 +104,9 @@ dochelp:
>  	@echo  '  cleandocs       - clean all generated files'
>  	@echo
>  	@echo  '  make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
> -	@echo  '  valid values for SPHINXDIRS are: $(_SPHINXDIRS)'
> +	@echo  '  top level values for SPHINXDIRS are: $(_SPHINXDIRS)'
> +	@echo  '  you may also use a subdirectory like SPHINXDIRS=userspace-api/media,'
> +	@echo  '  provided that there is an index.rst file at the subdirectory.'
>  	@echo

Applied, thanks.

jon