From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Akira Yokosawa <akiyks@gmail.com>,
Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v2 10/12] docs: kdoc: further rewrite_struct_members() cleanup
Date: Thu, 7 Aug 2025 15:16:37 -0600 [thread overview]
Message-ID: <20250807211639.47286-11-corbet@lwn.net> (raw)
In-Reply-To: <20250807211639.47286-1-corbet@lwn.net>
Get rid of some redundant checks, and generally tighten up the code; no
logical change.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
scripts/lib/kdoc/kdoc_parser.py | 86 ++++++++++++++++-----------------
1 file changed, 41 insertions(+), 45 deletions(-)
diff --git a/scripts/lib/kdoc/kdoc_parser.py b/scripts/lib/kdoc/kdoc_parser.py
index e3d0270b1a19..b3f937901037 100644
--- a/scripts/lib/kdoc/kdoc_parser.py
+++ b/scripts/lib/kdoc/kdoc_parser.py
@@ -673,73 +673,69 @@ class KernelDoc:
while tuples:
for t in tuples:
newmember = ""
- maintype = t[0]
- s_ids = t[5]
- content = t[3]
-
- oldmember = "".join(t)
-
- for s_id in s_ids.split(','):
+ oldmember = "".join(t) # Reconstruct the original formatting
+ dtype, name, lbr, content, rbr, rest, semi = t
+ #
+ # Pass through each field name, normalizing the form and formatting.
+ #
+ for s_id in rest.split(','):
s_id = s_id.strip()
-
- newmember += f"{maintype} {s_id}; "
+ newmember += f"{dtype} {s_id}; "
+ #
+ # Remove bitfield/array/pointer info, getting the bare name.
+ #
s_id = KernRe(r'[:\[].*').sub('', s_id)
s_id = KernRe(r'^\s*\**(\S+)\s*').sub(r'\1', s_id)
-
+ #
+ # Pass through the members of this inner structure/union.
+ #
for arg in content.split(';'):
arg = arg.strip()
-
- if not arg:
- continue
-
+ #
+ # Look for (type)(*name)(args) - pointer to function
+ #
r = KernRe(r'^([^\(]+\(\*?\s*)([\w.]*)(\s*\).*)')
if r.match(arg):
+ dtype, name, extra = r.group(1), r.group(2), r.group(3)
# Pointer-to-function
- dtype = r.group(1)
- name = r.group(2)
- extra = r.group(3)
-
- if not name:
- continue
-
if not s_id:
# Anonymous struct/union
newmember += f"{dtype}{name}{extra}; "
else:
newmember += f"{dtype}{s_id}.{name}{extra}; "
-
+ #
+ # Otherwise a non-function member.
+ #
else:
- # Handle bitmaps
+ #
+ # Remove bitmap and array portions and spaces around commas
+ #
arg = KernRe(r':\s*\d+\s*').sub('', arg)
-
- # Handle arrays
arg = KernRe(r'\[.*\]').sub('', arg)
-
- # Handle multiple IDs
arg = KernRe(r'\s*,\s*').sub(',', arg)
-
+ #
+ # Look for a normal decl - "type name[,name...]"
+ #
r = KernRe(r'(.*)\s+([\S+,]+)')
-
if r.search(arg):
- dtype = r.group(1)
- names = r.group(2)
+ for name in r.group(2).split(','):
+ name = KernRe(r'^\s*\**(\S+)\s*').sub(r'\1', name)
+ if not s_id:
+ # Anonymous struct/union
+ newmember += f"{r.group(1)} {name}; "
+ else:
+ newmember += f"{r.group(1)} {s_id}.{name}; "
else:
newmember += f"{arg}; "
- continue
-
- for name in names.split(','):
- name = KernRe(r'^\s*\**(\S+)\s*').sub(r'\1', name).strip()
-
- if not name:
- continue
-
- if not s_id:
- # Anonymous struct/union
- newmember += f"{dtype} {name}; "
- else:
- newmember += f"{dtype} {s_id}.{name}; "
-
+ #
+ # At the end of the s_id loop, replace the original declaration with
+ # the munged version.
+ #
members = members.replace(oldmember, newmember)
+ #
+ # End of the tuple loop - search again and see if there are outer members
+ # that now turn up.
+ #
tuples = struct_members.findall(members)
return members
--
2.50.1
next prev parent reply other threads:[~2025-08-07 21:16 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-07 21:16 [PATCH v2 00/12] docs: kdoc: thrash up dump_struct() Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 01/12] docs: kdoc: consolidate the stripping of private struct/union members Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 02/12] docs: kdoc: Move a regex line in dump_struct() Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 03/12] docs: kdoc: backslashectomy in kdoc_parser Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 04/12] docs: kdoc: move the prefix transforms out of dump_struct() Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 05/12] docs: kdoc: split top-level prototype parsing " Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 06/12] docs: kdoc: split struct-member rewriting " Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 07/12] docs: kdoc: rework the rewrite_struct_members() main loop Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 08/12] docs: kdoc: remove an extraneous strip() call Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 09/12] docs: kdoc: Some rewrite_struct_members() commenting Jonathan Corbet
2025-08-07 21:16 ` Jonathan Corbet [this message]
2025-08-09 15:44 ` [PATCH v2 10/12] docs: kdoc: further rewrite_struct_members() cleanup Mauro Carvalho Chehab
2025-08-07 21:16 ` [PATCH v2 11/12] docs: kdoc: extract output formatting from dump_struct() Jonathan Corbet
2025-08-07 21:16 ` [PATCH v2 12/12] docs: kdoc: a few final dump_struct() touches Jonathan Corbet
2025-08-09 15:47 ` [PATCH v2 00/12] docs: kdoc: thrash up dump_struct() Mauro Carvalho Chehab
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=20250807211639.47286-11-corbet@lwn.net \
--to=corbet@lwn.net \
--cc=akiyks@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.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;
as well as URLs for NNTP newsgroup(s).