raspi/linux
1
0
Fork 1
mirror of https://github.com/raspberrypi/linux.git synced 2025-12-06 18:09:56 +00:00
Code Issues Projects Releases Wiki Activity

docs: kdoc: remove the KernelEntry::is_kernel_comment member

Browse Source 
entry::is_kernel_comment never had anything to do with the entry itself; it
is a bit of local state in one branch of process_name().  It can, in fact,
be removed entirely; rework the code slightly so that it is no longer
needed.

No change in the rendered output.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250606163438.229916-6-corbet@lwn.net
This commit is contained in:
Jonathan Corbet
2025-06-06 10:34:34 -06:00
parent e76a1d2b26
commit 8f4650fe1a
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
scripts/lib/kdoc/kdoc_parser.py
View File

@@ -1224,7 +1224,6 @@ class KernelDoc:
if doc_decl.search(line):
self.entry.identifier = doc_decl.group(1)
self.entry.is_kernel_comment = False
decl_start = str(doc_com) # comment block asterisk
fn_type = r"(?:\w+\s*\*\s*)?" # type (for non-functions)
@@ -1242,14 +1241,20 @@ class KernelDoc:
if r.search(line):
self.entry.decl_type = r.group(1)
self.entry.identifier = r.group(2)
self.entry.is_kernel_comment = True
#
# Look for a function description
#
elif r2.search(line):
self.entry.identifier = r2.group(1)
self.entry.decl_type = "function"
self.entry.is_kernel_comment = True
#
# We struck out.
#
else:
self.emit_msg(ln,
f"This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n{line}")
self.state = state.NORMAL
return
self.entry.identifier = self.entry.identifier.strip(" ")
@@ -1271,11 +1276,6 @@ class KernelDoc:
else:
self.entry.declaration_purpose = ""
if not self.entry.is_kernel_comment:
self.emit_msg(ln,
f"This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n{line}")
self.state = state.NORMAL
if not self.entry.declaration_purpose and self.config.wshort_desc:
self.emit_msg(ln,
f"missing initial short description on line:\n{line}")