From: Joe Perches <joe@perches.com>
To: Randy Dunlap <rdunlap@infradead.org>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org,
Andrew Morton <akpm@linux-foundation.org>,
Matteo Croce <technoboy85@gmail.com>,
Shuah Khan <skhan@linuxfoundation.org>,
Matteo Croce <teknoraver@meta.com>
Subject: Re: [PATCH 2/9] docs: escape ** glob pattern in MAINTAINERS descriptions
Date: Mon, 04 May 2026 20:19:50 -0700 [thread overview]
Message-ID: <0b127006e552de855ba7d33c15d2199436a001cb.camel@perches.com> (raw)
In-Reply-To: <c2efc1a7-4406-4590-b863-5f258f3cae50@infradead.org>
On Mon, 2026-05-04 at 14:20 -0700, Randy Dunlap wrote:
> On 5/4/26 8:51 AM, Mauro Carvalho Chehab wrote:
> From: Matteo Croce <[teknoraver@meta.com](mailto:teknoraver@meta.com)>
> >
> > Escape '**' in the MAINTAINERS descriptions section to prevent
> > reStructuredText from interpreting it as bold/strong inline markup,
> > which causes a warning when running 'make htmldocs'.
[]
> It's nice to eliminate one warning from 'make htmldocs', so this is good
> in that regard. However, there are still multiple problems (not Warnings)
> with '*' characters in the MAINTAINERS file:
>
> 1) F: */net/* all files in "any top level directory"/net
>
> In the html output, it shows "/net/" italicized (that's what one * does).
>
> 2) F: fs/**/*foo*.c all *foo*.c files in any subdirectory of fs
>
> In the html output, it shows
>
> F: fs/**/foo.c all foo.c files in any subdirectory of fs
>
> with both occurrences of "foo.c" italicized (dropping the '*' characters).
>
> These 2 examples are actively wrong.
>
> [adding new:]
> We would be better served by just putting file patterns inside ``fs/**/*foo*.c``
> quotation marks IMO.
>
> Ah, similar to what you do in the table output.
>
> Oh, with one little glitch:
> E.g., in the very first entry for 3C59X NETWORK DRIVER,
> F: Documentation/networking/device_drivers/ethernet/3com/vortex.rst
> F: drivers/net/ethernet/3com/3c59x.c
> it looks like automarkup is applied to the Documentation file so these
> 2 files are displayed as:
>
> networking/device_drivers/ethernet/3com/vortex, drivers/net/ethernet/3com/3c59x.c
>
> with the Doc file underlined and missing both Documentation and .rst.
> Or maybe that's what you intended since the automarkup link does work.
> It's just not what I expected. Oh well.
Please stop trying to format MAINTAINERS into rst.
It shouldn't be formatted.
It's simple text.
next prev parent reply other threads:[~2026-05-05 3:20 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-04 15:51 [PATCH 0/9] Improve process/maintainers output Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 1/9] docs: maintainers_include: keep hidden TOC sorted Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 2/9] docs: escape ** glob pattern in MAINTAINERS descriptions Mauro Carvalho Chehab
2026-05-04 21:20 ` Randy Dunlap
2026-05-05 3:19 ` Joe Perches [this message]
2026-05-05 5:57 ` Mauro Carvalho Chehab
2026-05-05 6:46 ` Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 3/9] docs: maintainers_include.py: split state machine on multiple funcs Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 4/9] docs: maintainers_include: cleanup the code Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 5/9] docs: maintainers_include.py: clean most SPHINXDIRS=process warnings Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 6/9] docs: maintainers_include: do some coding style cleanups Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 7/9] docs: maintainers_include: store maintainers entries on a dict Mauro Carvalho Chehab
2026-05-04 15:51 ` [PATCH 8/9] docs: maintainers_include: don't ignore invalid profile entries Mauro Carvalho Chehab
2026-05-04 16:08 ` Miguel Ojeda
2026-05-04 20:26 ` Mauro Carvalho Chehab
2026-05-04 22:37 ` Gary Guo
2026-05-04 23:23 ` Mauro Carvalho Chehab
2026-05-05 0:25 ` Gary Guo
2026-05-04 23:34 ` Miguel Ojeda
2026-05-05 0:08 ` Mauro Carvalho Chehab
2026-05-05 0:20 ` Miguel Ojeda
2026-05-05 5:45 ` Mauro Carvalho Chehab
2026-05-05 11:16 ` Gary Guo
2026-05-05 13:09 ` Mauro Carvalho Chehab
2026-05-05 14:37 ` Miguel Ojeda
2026-05-04 15:51 ` [PATCH 9/9] docs: maintainers: add a filtering javascript Mauro Carvalho Chehab
2026-05-04 21:12 ` Randy Dunlap
2026-05-05 13:00 ` Mauro Carvalho Chehab
2026-05-04 21:13 ` [PATCH 0/9] Improve process/maintainers output Randy Dunlap
2026-05-05 12:50 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=0b127006e552de855ba7d33c15d2199436a001cb.camel@perches.com \
--to=joe@perches.com \
--cc=akpm@linux-foundation.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=mchehab@kernel.org \
--cc=rdunlap@infradead.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=technoboy85@gmail.com \
--cc=teknoraver@meta.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox