Commit 3050edfd authored by Nícolas F. R. A. Prado's avatar Nícolas F. R. A. Prado Committed by Mauro Carvalho Chehab
Browse files

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: default avatarNícolas F. R. A. Prado <nfraprado@protonmail.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent f66e47f9

Documentation/sphinx/automarkup.py

+8 −1
Original line number Diff line number Diff line
@@ -45,6 +45,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
@@ -133,7 +139,8 @@ def markup_c_ref(docname, app, match): 
    target = match.group(2)

    target_text = nodes.Text(match.group(0))

    xref = None

    if not (match.re == RE_function and target in Skipfuncs):

    if not ((match.re == RE_function and target in Skipfuncs)

            or (target in Skipnames)):

        lit_text = nodes.literal(classes=['xref', 'c', class_str[match.re]])

        lit_text += target_text

        pxref = addnodes.pending_xref('', refdomain = 'c',