MAINTAINERS: fix '*' wildcard formatting

[PATCH] MAINTAINERS: fix '*' wildcard formatting

Posted by Randy Dunlap 1 month ago

It seems that these wildcards confuse some parser (docutils, sphinx,
or maintainers_include.py), so quote them to avoid this issue.
Also insert a hyphen ('-') before "all files" in several places
to make the html output easier to read.

Fixes this htmldocs warning:

linux-next-20260304/MAINTAINERS:40: WARNING: Inline strong start-string without end-string. [docutils]

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org
Cc: Kees Cook <kees@kernel.org>

 MAINTAINERS |   10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

--- linux-next-20260304.orig/MAINTAINERS
+++ linux-next-20260304/MAINTAINERS
@@ -32,10 +32,10 @@ Descriptions of section entries and pref
 	   Type is one of: git, hg, quilt, stgit, topgit
 	F: *Files* and directories wildcard patterns.
 	   A trailing slash includes all files and subdirectory files.
-	   F:	drivers/net/	all files in and below drivers/net
-	   F:	drivers/net/*	all files in drivers/net, but not below
-	   F:	*/net/*		all files in "any top level directory"/net
-	   F:	fs/**/*foo*.c	all *foo*.c files in any subdirectory of fs
+	   F:	``drivers/net/``  -	all files in and below drivers/net
+	   F:	``drivers/net/*`` -	all files in drivers/net, but not below
+	   F:	``*/net/*``       -	all files in "any top level directory"/net
+	   F:	``fs/**/*foo*.c`` -	all *foo*.c files in any subdirectory of fs
 	   One pattern per line.  Multiple F: lines acceptable.
 	X: *Excluded* files and directories that are NOT maintained, same
 	   rules as F:. Files exclusions are tested before file matches.
@@ -44,7 +44,7 @@ Descriptions of section entries and pref
 	   X:	net/ipv6/
 	   matches all files in and below net excluding net/ipv6/
 	N: Files and directories *Regex* patterns.
-	   N:	[^a-z]tegra	all files whose path contains tegra
+	   N:	[^a-z]tegra -	all files whose path contains tegra
 	                        (not including files like integrator)
 	   One pattern per line.  Multiple N: lines acceptable.
 	   scripts/get_maintainer.pl has different behavior for files that

Re: [PATCH] MAINTAINERS: fix '*' wildcard formatting

Posted by Joe Perches 1 month ago

On Wed, 2026-03-04 at 14:42 -0800, Randy Dunlap wrote:
> It seems that these wildcards confuse some parser (docutils, sphinx,
> or maintainers_include.py), so quote them to avoid this issue.
> Also insert a hyphen ('-') before "all files" in several places
> to make the html output easier to read.
> 
> Fixes this htmldocs warning:
> 
> linux-next-20260304/MAINTAINERS:40: WARNING: Inline strong start-string without end-string. [docutils]

I think there should be a better way than this.
This just uglifies the perfectly readable ascii.

> 
> Signed-off-by: Randy Dunlap <[rdunlap@infradead.org](mailto:rdunlap@infradead.org)>
> ---
> Cc: Jonathan Corbet <[corbet@lwn.net](mailto:corbet@lwn.net)>
> Cc: Shuah Khan <[skhan@linuxfoundation.org](mailto:skhan@linuxfoundation.org)>
> Cc: [linux-doc@vger.kernel.org](mailto:linux-doc@vger.kernel.org)
> Cc: Kees Cook <[kees@kernel.org](mailto:kees@kernel.org)>
> 
>  MAINTAINERS |   10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> --- linux-next-20260304.orig/MAINTAINERS
> +++ linux-next-20260304/MAINTAINERS
> @@ -32,10 +32,10 @@ Descriptions of section entries and pref
>  	   Type is one of: git, hg, quilt, stgit, topgit
>  	F: *Files* and directories wildcard patterns.
>  	   A trailing slash includes all files and subdirectory files.
> -	   F:	drivers/net/	all files in and below drivers/net
> -	   F:	drivers/net/*	all files in drivers/net, but not below
> -	   F:	*/net/*		all files in "any top level directory"/net
> -	   F:	fs/**/*foo*.c	all *foo*.c files in any subdirectory of fs
> +	   F:	``drivers/net/``  -	all files in and below drivers/net
> +	   F:	``drivers/net/*`` -	all files in drivers/net, but not below
> +	   F:	``*/net/*``       -	all files in "any top level directory"/net
> +	   F:	``fs/**/*foo*.c`` -	all *foo*.c files in any subdirectory of fs
>  	   One pattern per line.  Multiple F: lines acceptable.
>  	X: *Excluded* files and directories that are NOT maintained, same
>  	   rules as F:. Files exclusions are tested before file matches.
> @@ -44,7 +44,7 @@ Descriptions of section entries and pref
>  	   X:	net/ipv6/
>  	   matches all files in and below net excluding net/ipv6/
>  	N: Files and directories *Regex* patterns.
> -	   N:	[^a-z]tegra	all files whose path contains tegra
> +	   N:	[^a-z]tegra -	all files whose path contains tegra
>  	                        (not including files like integrator)
>  	   One pattern per line.  Multiple N: lines acceptable.
>  	   scripts/get_maintainer.pl has different behavior for files that
> 
> ```

Re: [PATCH] MAINTAINERS: fix '*' wildcard formatting

Posted by Randy Dunlap 1 month ago


On 3/5/26 1:24 AM, Joe Perches wrote:
> On Wed, 2026-03-04 at 14:42 -0800, Randy Dunlap wrote:
>> It seems that these wildcards confuse some parser (docutils, sphinx,
>> or maintainers_include.py), so quote them to avoid this issue.
>> Also insert a hyphen ('-') before "all files" in several places
>> to make the html output easier to read.
>>
>> Fixes this htmldocs warning:
>>
>> linux-next-20260304/MAINTAINERS:40: WARNING: Inline strong start-string without end-string. [docutils]
> 
> I think there should be a better way than this.
> This just uglifies the perfectly readable ascii.
> 

Sure, we can just get along with this one warning. No problem.
Thanks.

>>
>> Signed-off-by: Randy Dunlap <[rdunlap@infradead.org](mailto:rdunlap@infradead.org)>
>> ---
>> Cc: Jonathan Corbet <[corbet@lwn.net](mailto:corbet@lwn.net)>
>> Cc: Shuah Khan <[skhan@linuxfoundation.org](mailto:skhan@linuxfoundation.org)>
>> Cc: [linux-doc@vger.kernel.org](mailto:linux-doc@vger.kernel.org)
>> Cc: Kees Cook <[kees@kernel.org](mailto:kees@kernel.org)>
>>
>>  MAINTAINERS |   10 +++++-----
>>  1 file changed, 5 insertions(+), 5 deletions(-)
>>
>> --- linux-next-20260304.orig/MAINTAINERS
>> +++ linux-next-20260304/MAINTAINERS
>> @@ -32,10 +32,10 @@ Descriptions of section entries and pref
>>  	   Type is one of: git, hg, quilt, stgit, topgit
>>  	F: *Files* and directories wildcard patterns.
>>  	   A trailing slash includes all files and subdirectory files.
>> -	   F:	drivers/net/	all files in and below drivers/net
>> -	   F:	drivers/net/*	all files in drivers/net, but not below
>> -	   F:	*/net/*		all files in "any top level directory"/net
>> -	   F:	fs/**/*foo*.c	all *foo*.c files in any subdirectory of fs
>> +	   F:	``drivers/net/``  -	all files in and below drivers/net
>> +	   F:	``drivers/net/*`` -	all files in drivers/net, but not below
>> +	   F:	``*/net/*``       -	all files in "any top level directory"/net
>> +	   F:	``fs/**/*foo*.c`` -	all *foo*.c files in any subdirectory of fs
>>  	   One pattern per line.  Multiple F: lines acceptable.
>>  	X: *Excluded* files and directories that are NOT maintained, same
>>  	   rules as F:. Files exclusions are tested before file matches.
>> @@ -44,7 +44,7 @@ Descriptions of section entries and pref
>>  	   X:	net/ipv6/
>>  	   matches all files in and below net excluding net/ipv6/
>>  	N: Files and directories *Regex* patterns.
>> -	   N:	[^a-z]tegra	all files whose path contains tegra
>> +	   N:	[^a-z]tegra -	all files whose path contains tegra
>>  	                        (not including files like integrator)
>>  	   One pattern per line.  Multiple N: lines acceptable.
>>  	   scripts/get_maintainer.pl has different behavior for files that


-- 
~Randy

Re: [PATCH] MAINTAINERS: fix '*' wildcard formatting

Posted by Jonathan Corbet 1 month ago

Randy Dunlap <rdunlap@infradead.org> writes:

> It seems that these wildcards confuse some parser (docutils, sphinx,
> or maintainers_include.py), so quote them to avoid this issue.
> Also insert a hyphen ('-') before "all files" in several places
> to make the html output easier to read.
>
> Fixes this htmldocs warning:
>
> linux-next-20260304/MAINTAINERS:40: WARNING: Inline strong start-string without end-string. [docutils]
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
> Cc: Kees Cook <kees@kernel.org>
>
>  MAINTAINERS |   10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)

I remain unconvinced that dragging all of MAINTAINERS into the docs
build brings any joy.  Is that something that you actually use?

(That said, as long as we're doing it, it should work properly)

Thanks,

jon

Re: [PATCH] MAINTAINERS: fix '*' wildcard formatting

Posted by Randy Dunlap 1 month ago


On 3/4/26 2:50 PM, Jonathan Corbet wrote:
> Randy Dunlap <rdunlap@infradead.org> writes:
> 
>> It seems that these wildcards confuse some parser (docutils, sphinx,
>> or maintainers_include.py), so quote them to avoid this issue.
>> Also insert a hyphen ('-') before "all files" in several places
>> to make the html output easier to read.
>>
>> Fixes this htmldocs warning:
>>
>> linux-next-20260304/MAINTAINERS:40: WARNING: Inline strong start-string without end-string. [docutils]
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> ---
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: Shuah Khan <skhan@linuxfoundation.org>
>> Cc: linux-doc@vger.kernel.org
>> Cc: Kees Cook <kees@kernel.org>
>>
>>  MAINTAINERS |   10 +++++-----
>>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> I remain unconvinced that dragging all of MAINTAINERS into the docs
> build brings any joy.  Is that something that you actually use?

No, I use '$editor MAINTAINERS'.
I'm quite good with rm Documentation/sphinx/maintainers_include.py.

> (That said, as long as we're doing it, it should work properly)
Yeah, just make the warning go away.

-- 
~Randy