linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: Re: [PATCH] docs: automarkup: Remove some Sphinx 2 holdovers
Date: Tue, 3 Jun 2025 23:32:42 +0200	[thread overview]
Message-ID: <20250603233242.3892f356@foz.lan> (raw)
In-Reply-To: <87h60wlp6g.fsf@trenco.lwn.net>

Em Tue, 03 Jun 2025 11:17:59 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> Remove a few declarations that are no longer doing anything now that we
> have left Sphinx 2 behind.
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
>  Documentation/sphinx/automarkup.py | 12 ++----------
>  1 file changed, 2 insertions(+), 10 deletions(-)
> 
> diff --git a/Documentation/sphinx/automarkup.py b/Documentation/sphinx/automarkup.py
> index fd633f7a0bc3..347de81c1ab7 100644
> --- a/Documentation/sphinx/automarkup.py
> +++ b/Documentation/sphinx/automarkup.py
> @@ -150,20 +150,12 @@ def markup_func_ref_sphinx3(docname, app, match):
>      return target_text
>  
>  def markup_c_ref(docname, app, match):
> -    class_str = {# Sphinx 2 only
> -                 RE_function: 'c-func',
> -                 RE_generic_type: 'c-type',
> -                 # Sphinx 3+ only
> -                 RE_struct: 'c-struct',
> +    class_str = {RE_struct: 'c-struct',
>                   RE_union: 'c-union',
>                   RE_enum: 'c-enum',
>                   RE_typedef: 'c-type',
>                   }
> -    reftype_str = {# Sphinx 2 only
> -                   RE_function: 'function',
> -                   RE_generic_type: 'type',
> -                   # Sphinx 3+ only
> -                   RE_struct: 'struct',
> +    reftype_str = {RE_struct: 'struct',
>                     RE_union: 'union',
>                     RE_enum: 'enum',
>                     RE_typedef: 'type',

Makes sense to me. I almost removed it on one of my patches, but I
ended forgetting about that ;-)

You probably can get rid of this too:

	#
	# Sphinx 2 uses the same :c:type role for struct, union, enum and typedef
	#
	RE_generic_type = re.compile(r'\b(struct|union|enum|typedef)\s+([a-zA-Z_]\w+)',
        	                     flags=re.ASCII)

As this is used only on the regular expressions you dropped.

After removing that:

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Thanks,
Mauro

      reply	other threads:[~2025-06-03 21:32 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-03 17:17 [PATCH] docs: automarkup: Remove some Sphinx 2 holdovers Jonathan Corbet
2025-06-03 21:32 ` Mauro Carvalho Chehab [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=20250603233242.3892f356@foz.lan \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=mchehab@kernel.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;
as well as URLs for NNTP newsgroup(s).