tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: automarkup.py: Skip C reserved words when cross-referencing

With the transition to Sphinx 3, new warnings were caused by
automarkup, exposing bugs in the name matching.

When automarkup parsed a text like "struct struct" in the documentation,
it tried to cross-reference to a "struct" symbol, which is recognized as
a C reserved word by Sphinx 3, generating a warning.

Add some C reserved words (only the ones that were causing warnings) to
a list and skip them while trying to cross-reference.

Signed-off-by: Nícolas F. R. A. Prado <nfraprado@protonmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

authored by

Nícolas F. R. A. Prado and committed by
Mauro Carvalho Chehab 3050edfd f66e47f9

+8 -1
+8 -1
Documentation/sphinx/automarkup.py
··· 46 46 RE_doc = re.compile(r'\bDocumentation(/[\w\-_/]+)(\.\w+)*') 47 47 48 48 # 49 + # Reserved C words that we should skip when cross-referencing 50 + # 51 + Skipnames = [ 'for', 'if', 'register', 'sizeof', 'struct', 'unsigned' ] 52 + 53 + 54 + # 49 55 # Many places in the docs refer to common system calls. It is 50 56 # pointless to try to cross-reference them and, as has been known 51 57 # to happen, somebody defining a function by these names can lead ··· 139 133 target = match.group(2) 140 134 target_text = nodes.Text(match.group(0)) 141 135 xref = None 142 - if not (match.re == RE_function and target in Skipfuncs): 136 + if not ((match.re == RE_function and target in Skipfuncs) 137 + or (target in Skipnames)): 143 138 lit_text = nodes.literal(classes=['xref', 'c', class_str[match.re]]) 144 139 lit_text += target_text 145 140 pxref = addnodes.pending_xref('', refdomain = 'c',