| From 86a0adc029d338f0da8989e7bb453c1114d51960 Mon Sep 17 00:00:00 2001 |
| From: Benjamin Gray <bgray@linux.ibm.com> |
| Date: Tue, 12 Sep 2023 16:07:56 +1000 |
| Subject: Documentation/sphinx: fix Python string escapes |
| |
| From: Benjamin Gray <bgray@linux.ibm.com> |
| |
| commit 86a0adc029d338f0da8989e7bb453c1114d51960 upstream. |
| |
| 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> |
| Message-ID: <20230912060801.95533-3-bgray@linux.ibm.com> |
| Signed-off-by: Jonathan Corbet <corbet@lwn.net> |
| Cc: Justin Forbes <jforbes@fedoraproject.org> |
| Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> |
| --- |
| 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(-) |
| |
| --- 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) + '``\\ ' |
| |
| # |
| # Parse Sphinx 3.x C markups, replacing them by backward-compatible ones |
| --- a/Documentation/sphinx/kernel_abi.py |
| +++ b/Documentation/sphinx/kernel_abi.py |
| @@ -102,7 +102,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(r"^\.\. LINENO (\S+)\#([0-9]+)$") |
| ln = 0 |
| n = 0 |
| f = fname |
| --- a/Documentation/sphinx/kernel_feat.py |
| +++ b/Documentation/sphinx/kernel_feat.py |
| @@ -95,7 +95,7 @@ class KernelFeat(Directive): |
| |
| lines = subprocess.check_output(args, cwd=os.path.dirname(doc.current_source)).decode('utf-8') |
| |
| - line_regex = re.compile("^\.\. FILE (\S+)$") |
| + line_regex = re.compile(r"^\.\. FILE (\S+)$") |
| |
| out_lines = "" |
| |
| --- a/Documentation/sphinx/kerneldoc.py |
| +++ b/Documentation/sphinx/kerneldoc.py |
| @@ -130,7 +130,7 @@ class KernelDocDirective(Directive): |
| result = ViewList() |
| |
| lineoffset = 0; |
| - line_regex = re.compile("^\.\. LINENO ([0-9]+)$") |
| + line_regex = re.compile(r"^\.\. LINENO ([0-9]+)$") |
| for line in lines: |
| match = line_regex.search(line) |
| if match: |
| --- a/Documentation/sphinx/maintainers_include.py |
| +++ b/Documentation/sphinx/maintainers_include.py |
| @@ -77,7 +77,7 @@ class MaintainersInclude(Include): |
| line = line.rstrip() |
| |
| # Linkify all non-wildcard refs to ReST files in Documentation/. |
| - pat = '(Documentation/([^\s\?\*]*)\.rst)' |
| + pat = r'(Documentation/([^\s\?\*]*)\.rst)' |
| m = re.search(pat, line) |
| if m: |
| # maintainers.rst is in a subdirectory, so include "../". |
| @@ -90,11 +90,11 @@ class MaintainersInclude(Include): |
| output = "| %s" % (line.replace("\\", "\\\\")) |
| # Look for and record field letter to field name mappings: |
| # R: Designated *reviewer*: FullName <address@domain> |
| - m = re.search("\s(\S):\s", line) |
| + m = re.search(r"\s(\S):\s", line) |
| if m: |
| field_letter = m.group(1) |
| if field_letter and not field_letter in fields: |
| - m = re.search("\*([^\*]+)\*", line) |
| + m = re.search(r"\*([^\*]+)\*", line) |
| if m: |
| fields[field_letter] = m.group(1) |
| elif subsystems: |
| @@ -112,7 +112,7 @@ class MaintainersInclude(Include): |
| field_content = "" |
| |
| # Collapse whitespace in subsystem name. |
| - heading = re.sub("\s+", " ", line) |
| + heading = re.sub(r"\s+", " ", line) |
| output = output + "%s\n%s" % (heading, "~" * len(heading)) |
| field_prev = "" |
| else: |
