linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] docs: Makefile: Sort Documentation targets case-insensitively in make help
@ 2025-10-15  1:29 Bhanu Seshu Kumar Valluri
  2025-10-27  5:27 ` Bhanu Seshu Kumar Valluri
  2025-10-29 16:18 ` Jonathan Corbet
  0 siblings, 2 replies; 4+ messages in thread
From: Bhanu Seshu Kumar Valluri @ 2025-10-15  1:29 UTC (permalink / raw)
  To: Jonathan Corbet, Randy Dunlap
  Cc: linux-doc, linux-kernel, khalid, linux-kernel-mentees, skhan,
	david.hunter.linux, bhanuseshukumar

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@gmail.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
-- 
2.34.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH] docs: Makefile: Sort Documentation targets case-insensitively in make help
  2025-10-15  1:29 [PATCH] docs: Makefile: Sort Documentation targets case-insensitively in make help Bhanu Seshu Kumar Valluri
@ 2025-10-27  5:27 ` Bhanu Seshu Kumar Valluri
  2025-10-27  5:55   ` Randy Dunlap
  2025-10-29 16:18 ` Jonathan Corbet
  1 sibling, 1 reply; 4+ messages in thread
From: Bhanu Seshu Kumar Valluri @ 2025-10-27  5:27 UTC (permalink / raw)
  To: Jonathan Corbet, Randy Dunlap
  Cc: linux-doc, linux-kernel, khalid, linux-kernel-mentees, skhan,
	david.hunter.linux

On 15/10/25 06:59, Bhanu Seshu Kumar Valluri wrote:
> 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@gmail.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
Hi,

I just wanted to check if you had a chance to review the patch or if any changes are needed from my side.

Regards,
Bhanu Seshu Kumar Valluri

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] docs: Makefile: Sort Documentation targets case-insensitively in make help
  2025-10-27  5:27 ` Bhanu Seshu Kumar Valluri
@ 2025-10-27  5:55   ` Randy Dunlap
  0 siblings, 0 replies; 4+ messages in thread
From: Randy Dunlap @ 2025-10-27  5:55 UTC (permalink / raw)
  To: Bhanu Seshu Kumar Valluri, Jonathan Corbet
  Cc: linux-doc, linux-kernel, khalid, linux-kernel-mentees, skhan,
	david.hunter.linux



On 10/26/25 10:27 PM, Bhanu Seshu Kumar Valluri wrote:
> On 15/10/25 06:59, Bhanu Seshu Kumar Valluri wrote:
>> 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@gmail.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
> Hi,
> 
> I just wanted to check if you had a chance to review the patch or if any changes are needed from my side.

It's OK with me and it works.

Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>

-- 
~Randy

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] docs: Makefile: Sort Documentation targets case-insensitively in make help
  2025-10-15  1:29 [PATCH] docs: Makefile: Sort Documentation targets case-insensitively in make help Bhanu Seshu Kumar Valluri
  2025-10-27  5:27 ` Bhanu Seshu Kumar Valluri
@ 2025-10-29 16:18 ` Jonathan Corbet
  1 sibling, 0 replies; 4+ messages in thread
From: Jonathan Corbet @ 2025-10-29 16:18 UTC (permalink / raw)
  To: Bhanu Seshu Kumar Valluri, Randy Dunlap
  Cc: linux-doc, linux-kernel, khalid, linux-kernel-mentees, skhan,
	david.hunter.linux, bhanuseshukumar

Bhanu Seshu Kumar Valluri <bhanuseshukumar@gmail.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@gmail.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

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2025-10-29 16:18 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-15  1:29 [PATCH] docs: Makefile: Sort Documentation targets case-insensitively in make help Bhanu Seshu Kumar Valluri
2025-10-27  5:27 ` Bhanu Seshu Kumar Valluri
2025-10-27  5:55   ` Randy Dunlap
2025-10-29 16:18 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).