linux-kernel - Re: [PATCH] docs: Makefile: Sort Documentation targets case-insensitively in make help

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: <874irhr89j.fsf@trenco.lwn.net>
Date: Wed, 29 Oct 2025 10:18:48 -0600
From: Jonathan Corbet <corbet@....net>
To: Bhanu Seshu Kumar Valluri <bhanuseshukumar@...il.com>, Randy Dunlap
 <rdunlap@...radead.org>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 khalid@...nel.org, linux-kernel-mentees@...ts.linuxfoundation.org,
 skhan@...uxfoundation.org, david.hunter.linux@...il.com,
 bhanuseshukumar@...il.com
Subject: Re: [PATCH] docs: Makefile: Sort Documentation targets
 case-insensitively in make help

Bhanu Seshu Kumar Valluri <bhanuseshukumar@...il.com> writes:

> Avoid case-sensitive sorting when listing Documentation targets in make help.
> Previously, targets like PCI and RCU appeared ahead of others due to uppercase
> names.
>
> Normalize casing during _SPHINXDIRS generation to ensure consistent and
> intuitive ordering.
>
> Fixes: 965fc39f7393 ("Documentation: sort _SPHINXDIRS for 'make help'")
> Signed-off-by: Bhanu Seshu Kumar Valluri <bhanuseshukumar@...il.com>
> ---
>  Notes
>  - Patch is tested with make help command.
>  - Verified case-insensitive sorting.
>
>  Documentation/Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 3609cb86137b..00c81e7947a9 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -23,7 +23,7 @@ SPHINXOPTS    =
>  SPHINXDIRS    = .
>  DOCS_THEME    =
>  DOCS_CSS      =
> -_SPHINXDIRS   = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst)))
> +_SPHINXDIRS   = $(shell printf "%s\n" $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst)) | sort -f)
>  SPHINX_CONF   = conf.py
>  PAPER         =
>  BUILDDIR      = $(obj)/output

I'm unconvinced that the extra complexity is really needed ... but I
went to apply it anyway.  Unfortunately, this patch doesn't apply to
docs-next.

Thanks,

jon