Linux Documentation
 help / color / mirror / Atom feed
From: "Nícolas F. R. A. Prado" <nfraprado@protonmail.com>
To: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Cc: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>,
	Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	lkcamp@lists.libreplanetbr.org, andrealmeid@collabora.com
Subject: Re: [PATCH RFC] docs: fix automarkup regression on Python 2
Date: Fri, 30 Oct 2020 16:12:22 +0000	[thread overview]
Message-ID: <C6QCQWW476W5.15PKD7G7AG16G@ArchWay> (raw)

On Fri Oct 30, 2020 at 12:51 PM -03, Jonathan Corbet wrote:
>
> It turns out that the Python 2 re module lacks the ASCII flag, so don't
> try
> to use it there.
>
> Fixes: f66e47f98c1e ("docs: automarkup.py: Fix regexes to solve sphinx 3
> warnings")
> Reported-by: Dafna Hirschfeld <dafna.hirschfeld@collabora.com>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
> Documentation/sphinx/automarkup.py | 20 ++++++++++++++------
> 1 file changed, 14 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/sphinx/automarkup.py
> b/Documentation/sphinx/automarkup.py
> index 409dbc4100de..3e81ebab26ed 100644
> --- a/Documentation/sphinx/automarkup.py
> +++ b/Documentation/sphinx/automarkup.py
> @@ -15,6 +15,14 @@ else:
> import re
> from itertools import chain
>
> +#
> +# Python 2 lacks re.ASCII...
> +#
> +try:
> + ascii_p3 = re.ASCII
> +except AttributeError:
> + ascii_p3 = 0
> +
> #
> # Regex nastiness. Of course.
> # Try to identify "function()" that's not already marked up some
> @@ -22,22 +30,22 @@ from itertools import chain
> # :c:func: block (i.e. ":c:func:`mmap()`s" flakes out), so the last
> # bit tries to restrict matches to things that won't create trouble.
> #
> -RE_function = re.compile(r'\b(([a-zA-Z_]\w+)\(\))', flags=re.ASCII)
> +RE_function = re.compile(r'\b(([a-zA-Z_]\w+)\(\))', flags=ascii_p3)
>
> #
> # 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)
> + flags=ascii_p3)
>
> #
> # Sphinx 3 uses a different C role for each one of struct, union, enum
> and
> # typedef
> #
> -RE_struct = re.compile(r'\b(struct)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
> -RE_union = re.compile(r'\b(union)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
> -RE_enum = re.compile(r'\b(enum)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
> -RE_typedef = re.compile(r'\b(typedef)\s+([a-zA-Z_]\w+)',
> flags=re.ASCII)
> +RE_struct = re.compile(r'\b(struct)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
> +RE_union = re.compile(r'\b(union)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
> +RE_enum = re.compile(r'\b(enum)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
> +RE_typedef = re.compile(r'\b(typedef)\s+([a-zA-Z_]\w+)',
> flags=ascii_p3)
>
> #
> # Detects a reference to a documentation page of the form
> Documentation/... with
> --
> 2.26.2

Looks good to me.

Thanks,
Nícolas


             reply	other threads:[~2020-10-30 16:12 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-30 16:12 Nícolas F. R. A. Prado [this message]
  -- strict thread matches above, loose matches on Subject: below --
2020-10-30 15:51 [PATCH RFC] docs: fix automarkup regression on Python 2 Jonathan Corbet

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=C6QCQWW476W5.15PKD7G7AG16G@ArchWay \
    --to=nfraprado@protonmail.com \
    --cc=andrealmeid@collabora.com \
    --cc=corbet@lwn.net \
    --cc=dafna.hirschfeld@collabora.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=lkcamp@lists.libreplanetbr.org \
    --cc=mchehab+huawei@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