raspi/linux
1
0
Fork 1
mirror of https://github.com/raspberrypi/linux.git synced 2025-12-07 10:29:52 +00:00
Code Issues Projects Releases Wiki Activity

docs: kdoc: move the core dispatch into a state table

Browse Source 
Since all of the handlers already nicely have the same prototype, put them
into a table and call them from there and take out the extended
if-then-else series.

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-3-corbet@lwn.net
This commit is contained in:
Jonathan Corbet
2025-06-06 10:34:31 -06:00
parent e8f0303e8b
commit cef8c781ca
1 changed files with 17 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1678,6 +1678,21 @@ class KernelDoc:
return export_table
#
# The state/action table telling us which function to invoke in
# each state.
#
state_actions = {
state.NORMAL: process_normal,
state.NAME: process_name,
state.BODY: process_body,
state.BODY_MAYBE: process_body,
state.BODY_WITH_BLANK_LINE: process_body,
state.INLINE: process_inline,
state.PROTO: process_proto,
state.DOCBLOCK: process_docblock,
}
def parse_kdoc(self):
"""
Open and process each line of a C source file.
@@ -1729,19 +1744,8 @@ class KernelDoc:
self.process_export(export_table, line)
# Hand this line to the appropriate state handler
if self.state == state.NORMAL:
self.process_normal(ln, line)
elif self.state == state.NAME:
self.process_name(ln, line)
elif self.state in [state.BODY, state.BODY_MAYBE,
state.BODY_WITH_BLANK_LINE]:
self.process_body(ln, line)
elif self.state == state.INLINE: # scanning for inline parameters
self.process_inline(ln, line)
elif self.state == state.PROTO:
self.process_proto(ln, line)
elif self.state == state.DOCBLOCK:
self.process_docblock(ln, line)
self.state_actions[self.state](self, ln, line)
except OSError:
self.config.log.error(f"Error: Cannot open file {self.fname}")