bybrooklyn/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-05 23:05:25 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: parse-headers.py: better handle @var arguments

Browse Source 
The kernel-doc markups inside headers may contain @var markups.

With the current rule, this would be converted into:

     \* @:c:type:`DMX_BUFFER_FLAG_DISCONTINUITY_INDICATOR <dmx_buffer_flags>`\:

Fix it adding a non-printed space if needed.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/8d06bb713d6ec8de65179dd93defe479715409b6.1755872208.git.mchehab+huawei@kernel.org
This commit is contained in:
Mauro Carvalho Chehab
2025-08-22 16:19:16 +02:00
committed by Jonathan Corbet
parent a2d58c917c
commit 285b8d3db2
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/sphinx/parse-headers.py
View File

@@ -120,12 +120,12 @@ class ParseHeader:
}, },
# This is the name of the enum itself # This is the name of the enum itself
"enum": { "enum": {
"prefix": "", "prefix": "\\ ",
"suffix": "\\ ", "suffix": "\\ ",
"ref_type": ":c:type", "ref_type": ":c:type",
}, },
"struct": { "struct": {
"prefix": "", "prefix": "\\ ",
"suffix": "\\ ", "suffix": "\\ ",
"ref_type": ":c:type", "ref_type": ":c:type",
}, },
@@ -390,6 +390,8 @@ class ParseHeader:
# Remove "\ " where not needed: before spaces and at the end of lines # Remove "\ " where not needed: before spaces and at the end of lines
text = re.sub(r"\\ ([\n ])", r"\1", text) text = re.sub(r"\\ ([\n ])", r"\1", text)
text = re.sub(r" \\ ", " ", text)
title = os.path.basename(file_in) title = os.path.basename(file_in)