linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: Joe Perches <joe@perches.com>
To: Matteo Croce <technoboy85@gmail.com>
Cc: kernel test robot <lkp@intel.com>,
	oe-kbuild-all@lists.linux.dev,
	Andrew Morton <akpm@linux-foundation.org>,
	Linux Memory Management List <linux-mm@kvack.org>
Subject: Re: [linux-next:master 8662/12838] htmldocs: MAINTAINERS:40: WARNING: Inline strong start-string without end-string. [docutils]
Date: Thu, 09 Apr 2026 09:23:10 -0700	[thread overview]
Message-ID: <c30a3fe0a6c412b1d0092a2eb4d4d878288ca935.camel@perches.com> (raw)
In-Reply-To: <CAFnufp0qW40DrZPG5akNaoXanRNN2MBW2ougcwThtzAXh-z5VA@mail.gmail.com>

On Thu, 2026-04-09 at 18:16 +0200, Matteo Croce wrote:
> ```
> Il giorno gio 9 apr 2026 alle ore 16:47 Joe Perches <[joe@perches.com](mailto:joe@perches.com)>
> ha scritto:
> > On Thu, 2026-04-09 at 12:12 +0200, Matteo Croce wrote:
> MAINTAINERS:40: WARNING: Inline strong start-string without end-string. [docutils]
> > > >    Documentation/userspace-api/landlock:480: ./security/landlock/errata/abi-4.h:5: ERROR: Unexpected section title.
> > > The problem is that "**" is seen as start of a bold text in RST.
> > > Escaping the first * fixes error and keeps the glob unaffected:
> > > 
> > > --- a/MAINTAINERS
> > > +++ b/MAINTAINERS
> > > @@ -35,7 +35,7 @@ Descriptions of section entries and preferred order
> > >      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: 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.
> > > 
> > > should I create a fix patch or we can still amend the previous in net-next?
> > 
> > nack.
> > 
> > this shouldn't be fixed this way.
> > betterwould be to not try to format things that shouldn't be formatted.
> 
> what about escaping it here?
> 
> --- a/Documentation/sphinx/maintainers_include.py
> +++ b/Documentation/sphinx/maintainers_include.py
> @@ -89,7 +89,8 @@ class MaintainersInclude(Include):
>              output = None
>              if descriptions:
>                  # Escape the escapes in preformatted text.
> -                output = "| %s" % (line.replace("\\", "\\\\"))
> +                output = "| %s" % (line.replace("\\", "\\\\")
> +                                        .replace("**", "\\**"))
>                  # Look for and record field letter to field name mappings:
>                  #   R: Designated *reviewer*: FullName <address@domain>
>                  m = re.search(r"\s(\S):\s", line)

I didn't know that file existed.  Fine by me as long as it works.


      reply	other threads:[~2026-04-09 16:23 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-09  5:24 kernel test robot
2026-04-09 10:12 ` Matteo Croce
2026-04-09 14:47   ` Joe Perches
2026-04-09 16:16     ` Matteo Croce
2026-04-09 16:23       ` Joe Perches [this message]

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=c30a3fe0a6c412b1d0092a2eb4d4d878288ca935.camel@perches.com \
    --to=joe@perches.com \
    --cc=akpm@linux-foundation.org \
    --cc=linux-mm@kvack.org \
    --cc=lkp@intel.com \
    --cc=oe-kbuild-all@lists.linux.dev \
    --cc=technoboy85@gmail.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