[PATCH 1/2] doc/sphinx: fix Python string escapes

From: Benjamin Gray bgray@linux.ibm.com
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
Adapted for U-Boot Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com --- doc/sphinx/cdomain.py | 2 +- doc/sphinx/kernel_abi.py | 2 +- doc/sphinx/kerneldoc.py | 2 +- doc/sphinx/maintainers_include.py | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/doc/sphinx/cdomain.py b/doc/sphinx/cdomain.py index 014a5229e57..491a7ed5f47 100644 --- a/doc/sphinx/cdomain.py +++ b/doc/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 diff --git a/doc/sphinx/kernel_abi.py b/doc/sphinx/kernel_abi.py index f3da859c987..32c50e496b5 100644 --- a/doc/sphinx/kernel_abi.py +++ b/doc/sphinx/kernel_abi.py @@ -147,7 +147,7 @@ class KernelCmd(Directive): code_block += "\n " + l lines = code_block + "\n\n"
- line_regex = re.compile("^#define LINENO (\S+)#([0-9]+)$") + line_regex = re.compile(r"^#define LINENO (\S+)#([0-9]+)$") ln = 0 n = 0 f = fname diff --git a/doc/sphinx/kerneldoc.py b/doc/sphinx/kerneldoc.py index 01a55429c57..bc8bb9e5125 100644 --- a/doc/sphinx/kerneldoc.py +++ b/doc/sphinx/kerneldoc.py @@ -130,7 +130,7 @@ class KernelDocDirective(Directive): result = ViewList()
lineoffset = 0; - line_regex = re.compile("^#define LINENO ([0-9]+)$") + line_regex = re.compile(r"^#define LINENO ([0-9]+)$") for line in lines: match = line_regex.search(line) if match: diff --git a/doc/sphinx/maintainers_include.py b/doc/sphinx/maintainers_include.py index dc8fed48d3c..6cee52cbb39 100755 --- a/doc/sphinx/maintainers_include.py +++ b/doc/sphinx/maintainers_include.py @@ -79,7 +79,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 "../". @@ -92,11 +92,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: @@ -114,7 +114,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:

When copying the build system for Linux we missed to replace some instances of 'Documentation' by 'doc'.
Signed-off-by: Heinrich Schuchardt heinrich.schuchardt@canonical.com --- doc/sphinx/maintainers_include.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/doc/sphinx/maintainers_include.py b/doc/sphinx/maintainers_include.py index 6cee52cbb39..13557d3d3c2 100755 --- a/doc/sphinx/maintainers_include.py +++ b/doc/sphinx/maintainers_include.py @@ -78,8 +78,8 @@ class MaintainersInclude(Include): # Drop needless input whitespace. line = line.rstrip()
- # Linkify all non-wildcard refs to ReST files in Documentation/. - pat = r'(Documentation/([^\s?*]*).rst)' + # Linkify all non-wildcard refs to ReST files in doc/. + pat = r'(doc/([^\s?*]*).rst)' m = re.search(pat, line) if m: # maintainers.rst is in a subdirectory, so include "../". @@ -177,11 +177,11 @@ class MaintainersInclude(Include): if not self.state.document.settings.file_insertion_enabled: raise self.warning('"%s" directive disabled.' % self.name)
- # Walk up source path directories to find Documentation/../ + # Walk up source path directories to find doc/../ path = self.state_machine.document.attributes['source'] path = os.path.realpath(path) tail = path - while tail != "Documentation" and tail != "": + while tail != "doc" and tail != "": (path, tail) = os.path.split(path)
# Append "MAINTAINERS"
participants (1)
-
Heinrich Schuchardt