archives/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-03-13 23:46:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: automarkup.py: Skip common English words as C identifiers

Browse source 
The automarkup extension incorrectly recognizes common English words
as C identifiers when they follow struct/union/enum/typedef keywords,
causing normal text like "... (a simple) struct that" (in `workqueue.rst`)
to be rendered as code blocks.

This patch adds Skipidentifiers list to filter out these words.

Signed-off-by: Yulong Han <wheatfox17@icloud.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260125124450.2005006-1-wheatfox17@icloud.com>
This commit is contained in:
wheatfox 2026-01-25 20:44:50 +08:00 • committed by Jonathan Corbet
parent a592a36e49
commit 6b8edfcd66
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Documentation/sphinx/automarkup.py
View file

@ -46,6 +46,12 @@ RE_namespace = re.compile(r'^\s*..\s*c:namespace::\s*(\S+)\s*$')
#
Skipnames = [ 'for', 'if', 'register', 'sizeof', 'struct', 'unsigned' ]
#
# Common English words that should not be recognized as C identifiers
# when following struct/union/enum/typedef keywords.
# Example: "a simple struct that" in workqueue.rst should not be marked as code.
#
Skipidentifiers = [ 'that', 'which', 'where', 'whose' ]
#
# Many places in the docs refer to common system calls. It is
@ -163,6 +169,10 @@ def markup_c_ref(docname, app, match):
if c_namespace:
possible_targets.insert(0, c_namespace + "." + base_target)
# Skip common English words that match identifier pattern but are not C code.
if base_target in Skipidentifiers:
return target_text
if base_target not in Skipnames:
for target in possible_targets:
if not (match.re == RE_function and target in Skipfuncs):