[PATCH 16/18] docs: kdoc_re: Change NestedMath args replacement to \0

Mauro Carvalho Chehab
2026-03-02T16:41:12Z

Future patches will allow parsing each argument instead of the
hole set. Prepare for it by changing the replace all args from
\1 to \0.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com>
---
tools/lib/python/kdoc/kdoc_parser.py | 2 +-
tools/lib/python/kdoc/kdoc_re.py | 8 ++++----
2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/tools/lib/python/kdoc/kdoc_parser.py b/tools/lib/python/kdoc/kdoc_parser.py
index 503a18212747..0f90c16cb51a 100644
--- a/tools/lib/python/kdoc/kdoc_parser.py
+++ b/tools/lib/python/kdoc/kdoc_parser.py
@@ -85,7 +85,7 @@ struct_nested_prefixes = [
(re.compile(r"__cond_acquires_shared\s*\("), ""),
(re.compile(r"__acquires_shared\s*\("), ""),
(re.compile(r"__releases_shared\s*\("), ""),
- (re.compile(r'\bSTRUCT_GROUP\('), r'\1'),
+ (re.compile(r'\bSTRUCT_GROUP\('), r'\0'),
]

#
diff --git a/tools/lib/python/kdoc/kdoc_re.py b/tools/lib/python/kdoc/kdoc_re.py
index 00afa5bccd6d..ea4f6f3d9e42 100644
--- a/tools/lib/python/kdoc/kdoc_re.py
+++ b/tools/lib/python/kdoc/kdoc_re.py
@@ -188,7 +188,7 @@ class NestedMatch:
# except that the content inside the match group is delimiter-aligned.
#
# The content inside parentheses is converted into a single replace
- # group (e.g. r`\1').
+ # group (e.g. r`\0').
#
# It would be nice to change such definition to support multiple
# match groups, allowing a regex equivalent to:
@@ -291,7 +291,7 @@ class NestedMatch:

if the sub argument contains::

- r'\1'
+ r'\0'

it will work just like re: it places there the matched paired data
with the delimiter stripped.
@@ -310,9 +310,9 @@ class NestedMatch:
# Value, ignoring start/end delimiters
value = line[end:pos - 1]

- # replaces \1 at the sub string, if \1 is used there
+ # replaces \0 at the sub string, if \0 is used there
new_sub = sub
- new_sub = new_sub.replace(r'\1', value)
+ new_sub = new_sub.replace(r'\0', value)

out += new_sub

--
2.52.0