path: root/Documentation/sphinx
diff options
authorNĂ­colas F. R. A. Prado <>2020-10-13 23:13:23 +0000
committerMauro Carvalho Chehab <>2020-10-15 07:49:38 +0200
commit3050edfd7971da7fddc77ac7c4607697ec10a554 (patch)
treedb40d4a8659d602f8b61651b8f40fa000b457a6e /Documentation/sphinx
parentf66e47f98c1e827a85654a8cfa1ba539bb381a1b (diff)
docs: 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 <> Signed-off-by: Mauro Carvalho Chehab <>
Diffstat (limited to 'Documentation/sphinx')
1 files changed, 8 insertions, 1 deletions
diff --git a/Documentation/sphinx/ b/Documentation/sphinx/
index 43dd9025fc77..1cc3a2cf2a88 100644
--- a/Documentation/sphinx/
+++ b/Documentation/sphinx/
@@ -46,6 +46,12 @@ RE_typedef = re.compile(r'\b(typedef)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
RE_doc = re.compile(r'\bDocumentation(/[\w\-_/]+)(\.\w+)*')
+# Reserved C words that we should skip when cross-referencing
+Skipnames = [ 'for', 'if', 'register', 'sizeof', 'struct', 'unsigned' ]
# Many places in the docs refer to common system calls. It is
# pointless to try to cross-reference them and, as has been known
# to happen, somebody defining a function by these names can lead
@@ -133,7 +139,8 @@ def markup_c_ref(docname, app, match):
target =
target_text = nodes.Text(
xref = None
- if not ( == RE_function and target in Skipfuncs):
+ if not (( == RE_function and target in Skipfuncs)
+ or (target in Skipnames)):
lit_text = nodes.literal(classes=['xref', 'c', class_str[]])
lit_text += target_text
pxref = addnodes.pending_xref('', refdomain = 'c',