From: Benjamin Gray <bgray@linux.ibm.com>
To: Jonathan Corbet <corbet@lwn.net>,
linux-kernel@vger.kernel.org, linux-ia64@vger.kernel.org,
linux-doc@vger.kernel.org, bpf@vger.kernel.org,
linux-pm@vger.kernel.org
Cc: abbotti@mev.co.uk, hsweeten@visionengravers.com,
jan.kiszka@siemens.com, kbingham@kernel.org, mykolal@fb.com
Subject: Re: [PATCH 2/8] Documentation/sphinx: fix Python string escapes
Date: Tue, 15 Aug 2023 09:26:10 +1000 [thread overview]
Message-ID: <ab85e604-b7ba-dbbe-53c2-2454e145d829@linux.ibm.com> (raw)
In-Reply-To: <87jztxwxtu.fsf@meer.lwn.net>
On 14/8/23 11:35 pm, Jonathan Corbet wrote:
> Benjamin Gray <bgray@linux.ibm.com> writes:
>
>> Python 3.6 introduced a DeprecationWarning for invalid escape sequences.
>> This is upgraded to a SyntaxWarning in Python 3.12, and will eventually
>> be a syntax error.
>>
>> Fix these now to get ahead of it before it's an error.
>>
>> Signed-off-by: Benjamin Gray <bgray@linux.ibm.com>
>> ---
>> Documentation/sphinx/cdomain.py | 2 +-
>> Documentation/sphinx/kernel_abi.py | 2 +-
>> Documentation/sphinx/kernel_feat.py | 2 +-
>> Documentation/sphinx/kerneldoc.py | 2 +-
>> Documentation/sphinx/maintainers_include.py | 8 ++++----
>> 5 files changed, 8 insertions(+), 8 deletions(-)
>
> So I am the maintainer for this stuff...is there a reason you didn't
> copy me on this work?
Sorry, I thought the list linux-doc@vger.kernel.org itself was enough. I
haven't done a cross tree series before, I was a bit adverse to CC'ing
everyone that appears as a maintainer for every patch.
>
>> diff --git a/Documentation/sphinx/cdomain.py b/Documentation/sphinx/cdomain.py
>> index ca8ac9e59ded..dbdc74bd0772 100644
>> --- a/Documentation/sphinx/cdomain.py
>> +++ b/Documentation/sphinx/cdomain.py
>> @@ -93,7 +93,7 @@ def markup_ctype_refs(match):
>> #
>> RE_expr = re.compile(r':c:(expr|texpr):`([^\`]+)`')
>> def markup_c_expr(match):
>> - return '\ ``' + match.group(2) + '``\ '
>> + return '\\ ``' + match.group(2) + '``\\ '
>
> I have to wonder about this one; I doubt the intent was to insert a
> literal backslash. I have to fire up my ancient build environment to
> even try this, but even if it's right...
Yeah, there is even a file that just has a syntax error. I don't have a
way to verify the original script was correct, but I have verified this
series doesn't change the parsed AST.
In this case though, it's generating reST, so it might just be
conservatively guarding against generating bad markup[1]
[1]:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#inline-markup
>> #
>> # Parse Sphinx 3.x C markups, replacing them by backward-compatible ones
>> diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py
>> index b5feb5b1d905..b9f026f016fd 100644
>> --- a/Documentation/sphinx/kernel_abi.py
>> +++ b/Documentation/sphinx/kernel_abi.py
>> @@ -138,7 +138,7 @@ class KernelCmd(Directive):
>> code_block += "\n " + l
>> lines = code_block + "\n\n"
>>
>> - line_regex = re.compile("^\.\. LINENO (\S+)\#([0-9]+)$")
>> + line_regex = re.compile("^\\.\\. LINENO (\\S+)\\#([0-9]+)$")
>
> All of these really just want to be raw strings - a much more minimal
> fix that makes the result quite a bit more readable:
>
> line_regex = re.compile(r"^\.\. LINENO (\S+)\#([0-9]+)$")
> ^
> |
> ---------------------------+
>
> That, I think, is how these should be fixed.
Yup, I mentioned that at the end of the cover letter. I can automate and
verify the conversion, but automating what _should_ be treated as a
'regex' string is fuzzier. Checking if there's a `re.*(` prefix on the
string should work for most though. I'll give it a shot.
> Thanks,
>
> jon
next prev parent reply other threads:[~2023-08-14 23:27 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-14 6:06 [PATCH 0/8] Fix Python string escapes Benjamin Gray
2023-08-14 6:06 ` [PATCH 1/8] ia64: fix " Benjamin Gray
2023-08-14 6:06 ` [PATCH 2/8] Documentation/sphinx: " Benjamin Gray
2023-08-14 13:35 ` Jonathan Corbet
2023-08-14 23:26 ` Benjamin Gray [this message]
2023-08-14 6:06 ` [PATCH 3/8] drivers/comedi: " Benjamin Gray
2023-08-14 6:07 ` [PATCH 4/8] scripts: " Benjamin Gray
2023-08-14 6:07 ` [PATCH 5/8] tools/perf: " Benjamin Gray
2023-08-14 6:07 ` [PATCH 6/8] tools/power: " Benjamin Gray
2023-08-14 6:07 ` [PATCH 7/8] selftests/bpf: " Benjamin Gray
2023-08-14 6:07 ` [PATCH 8/8] selftests/bpf: fix Python string escapes in f-strings Benjamin Gray
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=ab85e604-b7ba-dbbe-53c2-2454e145d829@linux.ibm.com \
--to=bgray@linux.ibm.com \
--cc=abbotti@mev.co.uk \
--cc=bpf@vger.kernel.org \
--cc=corbet@lwn.net \
--cc=hsweeten@visionengravers.com \
--cc=jan.kiszka@siemens.com \
--cc=kbingham@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-ia64@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=mykolal@fb.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).