From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
intel-wired-lan@lists.osuosl.org,
linux-hardening@vger.kernel.org, linux-kernel@vger.kernel.org,
netdev@vger.kernel.org,
Aleksandr Loktionov <aleksandr.loktionov@intel.com>,
Randy Dunlap <rdunlap@infradead.org>
Subject: [PATCH 19/38] docs: kdoc_re: make NestedMatch use KernRe
Date: Wed, 18 Feb 2026 11:12:49 +0100 [thread overview]
Message-ID: <a27f96e3e6e2b58bf1e4e7aab8a592d81f32887f.1771408406.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1771408406.git.mchehab+huawei@kernel.org>
Instead of using re_compile, let's create the class with the
regex and use KernRe to keep it cached.
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 | 55 ++++++++--------------------
tools/lib/python/kdoc/kdoc_re.py | 24 ++++++++----
2 files changed, 33 insertions(+), 46 deletions(-)
diff --git a/tools/lib/python/kdoc/kdoc_parser.py b/tools/lib/python/kdoc/kdoc_parser.py
index 3ee169b505d3..06a7af4bfa57 100644
--- a/tools/lib/python/kdoc/kdoc_parser.py
+++ b/tools/lib/python/kdoc/kdoc_parser.py
@@ -153,32 +153,7 @@ struct_xforms = [
(KernRe(r'DEFINE_DMA_UNMAP_ADDR\s*\(' + struct_args_pattern + r'\)', re.S), r'dma_addr_t \1'),
(KernRe(r'DEFINE_DMA_UNMAP_LEN\s*\(' + struct_args_pattern + r'\)', re.S), r'__u32 \1'),
(KernRe(r'VIRTIO_DECLARE_FEATURES\(([\w_]+)\)'), r'union { u64 \1; u64 \1_array[VIRTIO_FEATURES_U64S]; }'),
-]
-#
-# Struct regexes here are guaranteed to have the end delimiter matching
-# the start delimiter. Yet, right now, only one replace group
-# is allowed.
-#
-struct_nested_prefixes = [
- (re.compile(r'\bSTRUCT_GROUP\('), r'\0'),
-]
-
-#
-# Function Regexes here are guaranteed to have the end delimiter matching
-# the start delimiter.
-#
-function_nested_prefixes = [
- (re.compile(r"__cond_acquires\s*\("), ""),
- (re.compile(r"__cond_releases\s*\("), ""),
- (re.compile(r"__acquires\s*\("), ""),
- (re.compile(r"__releases\s*\("), ""),
- (re.compile(r"__must_hold\s*\("), ""),
- (re.compile(r"__must_not_hold\s*\("), ""),
- (re.compile(r"__must_hold_shared\s*\("), ""),
- (re.compile(r"__cond_acquires_shared\s*\("), ""),
- (re.compile(r"__acquires_shared\s*\("), ""),
- (re.compile(r"__releases_shared\s*\("), ""),
- (re.compile(r"__attribute__\s*\("), ""),
+ (NestedMatch(r'\bSTRUCT_GROUP\('), r'\0'),
]
#
@@ -211,6 +186,17 @@ function_xforms = [
(KernRe(r"DECL_BUCKET_PARAMS\s*\(\s*(\S+)\s*,\s*(\S+)\s*\)"), r"\1, \2"),
(KernRe(r"__no_context_analysis\s*"), ""),
(KernRe(r"__attribute_const__ +"), ""),
+ (NestedMatch(r"__cond_acquires\s*\("), ""),
+ (NestedMatch(r"__cond_releases\s*\("), ""),
+ (NestedMatch(r"__acquires\s*\("), ""),
+ (NestedMatch(r"__releases\s*\("), ""),
+ (NestedMatch(r"__must_hold\s*\("), ""),
+ (NestedMatch(r"__must_not_hold\s*\("), ""),
+ (NestedMatch(r"__must_hold_shared\s*\("), ""),
+ (NestedMatch(r"__cond_acquires_shared\s*\("), ""),
+ (NestedMatch(r"__acquires_shared\s*\("), ""),
+ (NestedMatch(r"__releases_shared\s*\("), ""),
+ (NestedMatch(r"__attribute__\s*\("), ""),
]
#
@@ -231,7 +217,6 @@ var_xforms = [
# Ancillary functions
#
-
multi_space = KernRe(r'\s\s+')
def trim_whitespace(s):
"""
@@ -425,8 +410,6 @@ class KernelDoc:
# Place all potential outputs into an array
self.entries = []
- self.nested = NestedMatch()
-
#
# We need Python 3.7 for its "dicts remember the insertion
# order" guarantee
@@ -524,14 +507,11 @@ class KernelDoc:
# State flags
self.state = state.NORMAL
- def apply_transforms(self, regex_xforms, nested_xforms, text):
+ def apply_transforms(self, xforms, text):
"""Apply a set of transforms to a block of text."""
- for search, subst in regex_xforms:
+ for search, subst in xforms:
text = search.sub(subst, text)
- for search, sub in nested_xforms:
- text = self.nested.sub(search, sub, text)
-
return text.strip()
def push_parameter(self, ln, decl_type, param, dtype,
@@ -910,8 +890,7 @@ class KernelDoc:
# Go through the list of members applying all of our transformations.
#
members = trim_private_members(members)
- members = self.apply_transforms(struct_xforms, struct_nested_prefixes,
- members)
+ members = self.apply_transforms(struct_xforms, members)
#
# Deal with embedded struct and union members, and drop enums entirely.
@@ -1126,9 +1105,7 @@ class KernelDoc:
#
# Apply the initial transformations.
#
- prototype = self.apply_transforms(function_xforms,
- function_nested_prefixes,
- prototype)
+ prototype = self.apply_transforms(function_xforms, prototype)
# Yes, this truly is vile. We are looking for:
# 1. Return type (may be nothing if we're looking at a macro)
diff --git a/tools/lib/python/kdoc/kdoc_re.py b/tools/lib/python/kdoc/kdoc_re.py
index 2d83b6fb1cd6..fed9894a5c71 100644
--- a/tools/lib/python/kdoc/kdoc_re.py
+++ b/tools/lib/python/kdoc/kdoc_re.py
@@ -200,7 +200,10 @@ class NestedMatch:
#
# FOO(arg1, arg2, arg3)
- def _search(self, regex, line):
+ def __init__(self, regex):
+ self.regex = KernRe(regex)
+
+ def _search(self, line):
"""
Finds paired blocks for a regex that ends with a delimiter.
@@ -222,7 +225,7 @@ class NestedMatch:
stack = []
- for match_re in regex.finditer(line):
+ for match_re in self.regex.finditer(line):
start = match_re.start()
offset = match_re.end()
string_char = None
@@ -270,7 +273,7 @@ class NestedMatch:
yield start, offset, pos + 1
break
- def search(self, regex, line):
+ def search(self, line):
"""
This is similar to re.search:
@@ -278,12 +281,12 @@ class NestedMatch:
returning occurrences only if all delimiters are paired.
"""
- for t in self._search(regex, line):
+ for t in self._search(line):
yield line[t[0]:t[2]]
- def sub(self, regex, sub, line, count=0):
- r"""
+ def sub(self, sub, line, count=0):
+ """
This is similar to re.sub:
It matches a regex that it is followed by a delimiter,
@@ -304,7 +307,7 @@ class NestedMatch:
cur_pos = 0
n = 0
- for start, end, pos in self._search(regex, line):
+ for start, end, pos in self._search(line):
out += line[cur_pos:start]
# Value, ignoring start/end delimiters
@@ -331,3 +334,10 @@ class NestedMatch:
out += line[cur_pos:l]
return out
+
+ def __repr__(self):
+ """
+ Returns a displayable version of the class init.
+ """
+
+ return f'NestedMatch("{self.regex.regex.pattern}")'
--
2.52.0
next prev parent reply other threads:[~2026-02-18 10:13 UTC|newest]
Thread overview: 55+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-18 10:12 [PATCH 00/38] docs: several improvements to kernel-doc Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 01/38] docs: kdoc_re: add support for groups() Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 02/38] docs: kdoc_re: don't go past the end of a line Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 03/38] docs: kdoc_parser: move var transformers to the beginning Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 04/38] docs: kdoc_parser: don't mangle with function defines Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 05/38] docs: kdoc_parser: add functions support for NestedMatch Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 06/38] docs: kdoc_parser: use NestedMatch to handle __attribute__ on functions Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 07/38] docs: kdoc_parser: fix variable regexes to work with size_t Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 08/38] docs: kdoc_parser: fix the default_value logic for variables Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 09/38] docs: kdoc_parser: add some debug for variable parsing Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 10/38] docs: kdoc_parser: don't exclude defaults from prototype Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 11/38] docs: kdoc_parser: fix parser to support multi-word types Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 12/38] docs: kdoc_parser: ignore context analysis and lock attributes Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 13/38] docs: kdoc_parser: add support for LIST_HEAD Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 14/38] docs: kdoc_parser: handle struct member macro VIRTIO_DECLARE_FEATURES(name) Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 15/38] docs: kdoc_re: properly handle strings and escape chars on it Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 16/38] docs: kdoc_re: better show KernRe() at documentation Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 17/38] docs: kdoc_re: don't recompile NestedMatch regex every time Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 18/38] docs: kdoc_re: Change NestedMath args replacement to \0 Mauro Carvalho Chehab
2026-02-18 10:12 ` Mauro Carvalho Chehab [this message]
2026-02-18 10:12 ` [PATCH 20/38] docs: kdoc_re: add support on NestedMatch for argument replacement Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 21/38] docs: kdoc_parser: better handle struct_group macros Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 22/38] docs: kdoc_re: fix a parse bug on struct page_pool_params Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 23/38] docs: kdoc_re: add a helper class to declare C function matches Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 24/38] docs: kdoc_parser: use the new CFunction class Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 25/38] docs: kdoc_parser: minimize differences with struct_group_tagged Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 26/38] docs: kdoc_parser: move transform lists to a separate file Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 27/38] docs: kdoc_re: don't remove the trailing ";" with NestedMatch Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 28/38] docs: kdoc_re: prevent adding whitespaces on sub replacements Mauro Carvalho Chehab
2026-02-18 10:12 ` [PATCH 29/38] docs: xforms_lists.py: use CFuntion to handle all function macros Mauro Carvalho Chehab
2026-02-18 10:13 ` [PATCH 30/38] docs: kdoc_files: allows the caller to use a different xforms class Mauro Carvalho Chehab
2026-02-18 10:13 ` [PATCH 31/38] docs: kdoc_re: Fix NestedMatch.sub() which causes PDF builds to break Mauro Carvalho Chehab
2026-02-18 10:13 ` [PATCH 32/38] docs: kdoc_files: document KernelFiles() ABI Mauro Carvalho Chehab
2026-02-18 10:13 ` [PATCH 33/38] docs: kdoc_output: add optional args to ManOutput class Mauro Carvalho Chehab
2026-02-18 10:13 ` [PATCH 34/38] docs: sphinx-build-wrapper: better handle troff .TH markups Mauro Carvalho Chehab
2026-02-18 10:13 ` [PATCH 35/38] docs: kdoc_output: use a more standard order for .TH on man pages Mauro Carvalho Chehab
2026-02-18 10:13 ` [PATCH 36/38] docs: sphinx-build-wrapper: don't allow "/" on file names Mauro Carvalho Chehab
2026-02-18 10:13 ` [PATCH 37/38] docs: kdoc_output: describe the class init parameters Mauro Carvalho Chehab
2026-02-18 10:13 ` [PATCH 38/38] docs: kdoc_output: pick a better default for modulename Mauro Carvalho Chehab
2026-02-21 1:24 ` [PATCH 00/38] docs: several improvements to kernel-doc Randy Dunlap
2026-02-22 1:24 ` Randy Dunlap
2026-02-23 13:47 ` Jani Nikula
2026-02-23 15:02 ` Jonathan Corbet
2026-02-24 13:25 ` [Intel-wired-lan] " Mauro Carvalho Chehab
2026-03-04 10:07 ` Jani Nikula
2026-03-04 12:20 ` [Intel-wired-lan] " Mauro Carvalho Chehab
2026-03-04 22:34 ` Jonathan Corbet
2026-03-13 10:48 ` [Intel-wired-lan] " Mauro Carvalho Chehab
2026-03-03 14:53 ` Mauro Carvalho Chehab
2026-03-03 15:12 ` Loktionov, Aleksandr
2026-03-03 16:09 ` [Intel-wired-lan] " Mauro Carvalho Chehab
2026-03-04 9:51 ` Jani Nikula
2026-02-23 21:58 ` Jonathan Corbet
2026-03-02 15:54 ` [Intel-wired-lan] " Mauro Carvalho Chehab
2026-03-02 16:14 ` 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=a27f96e3e6e2b58bf1e4e7aab8a592d81f32887f.1771408406.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=aleksandr.loktionov@intel.com \
--cc=corbet@lwn.net \
--cc=intel-wired-lan@lists.osuosl.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hardening@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=rdunlap@infradead.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
all inboxes | Powered by JetHome®