mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Manuel Ebner <manuelebnerli@mailbox.org>
To: Weijie Yuan <wy@wyuan.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	 Shuah Khan <skhan@linuxfoundation.org>,
	"open list:DOCUMENTATION PROCESS" <workflows@vger.kernel.org>,
	 "open list:DOCUMENTATION"	 <linux-doc@vger.kernel.org>,
	open list <linux-kernel@vger.kernel.org>
Subject: Re: [Issue] sphinx: incorrect high-lighting
Date: Sun, 23 Aug 2026 20:08:25 +0200	[thread overview]
Message-ID: <c7a3db22f56c598ef35676288d10303af21098bf.camel@mailbox.org> (raw)
In-Reply-To: <aosYfdfH6Z7ai5M2@wyuan.org>

On Sun, 2026-08-23 at 23:57 +0800, Weijie Yuan wrote:
> On Sun, Aug 23, 2026 at 05:14:20PM +0200, Manuel Ebner wrote:
> > I think in the documentation is some incorrect auto high-lighting.
> > 
> > https://docs.kernel.org/process/deprecated.html
> > 
> > Line 272:
> > > when such a struct was in unions, structs of structs, etc).
> > with 'struct was' bold.
> > 
> > Line 358:
> > > alone in a struct or is part of a union. These are disallowed by the C99
> > with 'struct or' bold as well.
> > 
> > Other files have the same issue:
> > E.g.: https://docs.kernel.org/process/adding-syscalls.html
> > 
> > Unfortunately I don't know how to fix this.
> 
> Hi Manuel,
> 
> I think we can just add "or" and "was" to Skipidentifiers, so that it
> won't be treated as C identifiers.
> 
> --- a/Documentation/sphinx/automarkup.py
> +++ b/Documentation/sphinx/automarkup.py
> @@ -51,7 +51,7 @@ Skipnames = [ 'for', 'if', 'register', 'sizeof', 'struct', 'unsigned' ]
>  # when following struct/union/enum/typedef keywords.
>  # Example: "a simple struct that" in workqueue.rst should not be marked as code.
>  #
> -Skipidentifiers = [ 'that', 'which', 'where', 'whose' ]
> +Skipidentifiers = [ 'or', 'that', 'was', 'which', 'where', 'whose' ]
>  
>  #
>  # Many places in the docs refer to common system calls.  It is
> 
> But I find more words needs to be added when looking at
> process/adding-syscalls.rst. 

It would be this list:
Skipidentifiers = [ 'and', 'are', 'as', 'containing', 'element', 'in',
                    'including', 'is', 'name', 'needs', 'of', 'or',  'page',
                    'pages', 'passed', 'randomization', 'request', 'that',
                    'to', 'where', 'which', 'whose', 'will' ]

> Adding the falsely highlighted words one by
> one may not be a perfect solution, since it could potentially affect
> other places where those words should actually be highlighted. So I'm
> not quite sure what the best approach is either now.

Me neither.

Thanks
 Manuel

> Thanks.

  reply	other threads:[~2026-08-23 18:08 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-23 15:14 Manuel Ebner
2026-08-23 15:57 ` Weijie Yuan
2026-08-23 18:08   ` Manuel Ebner [this message]
2026-08-23 18:47     ` Randy Dunlap
2026-08-24 13:26     ` Jonathan Corbet
2026-08-30  7:13       ` Manuel Ebner

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=c7a3db22f56c598ef35676288d10303af21098bf.camel@mailbox.org \
    --to=manuelebnerli@mailbox.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=workflows@vger.kernel.org \
    --cc=wy@wyuan.org \
    /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

all inboxes | Powered by JetHome®