Documentation/sphinx/automarkup.py

1 # SPDX-License-Identifier: GPL-2.0
4 # Apply kernel-specific tweaks after the initial document processing
23 RE_function = re.compile(r'\b(([a-zA-Z_]\w+)\(\))', flags=re.ASCII)
28 RE_generic_type = re.compile(r'\b(struct|union|enum|typedef)\s+([a-zA-Z_]\w+)',
35 RE_struct = re.compile(r'\b(struct)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
36 RE_union = re.compile(r'\b(union)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
37 RE_enum = re.compile(r'\b(enum)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
38 RE_typedef = re.compile(r'\b(typedef)\s+([a-zA-Z_]\w+)', flags=re.ASCII)
44 RE_doc = re.compile(r'(\bDocumentation/)?((\.\./)*[\w\-/]+)\.(rst|txt)')
45 RE_abi_file = re.compile(r'(\bDocumentation/ABI/[\w\-/]+)')
46 RE_abi_symbol = re.compile(r'(\b/(sys|config|proc)/[\w\-/]+)')
51 # Reserved C words that we should skip when cross-referencing
58 # pointless to try to cross-reference them and, as has been known
72 RE_git = re.compile(r'commit\s+(?P<rev>[0-9a-f]{12,40})(?:\s+\(".*?"\))?',
117 # Keep track of cross-reference lookups that failed so we don't have to
127 # In sphinx3 we can cross-reference to C macro and function, each one with its
140     # cross-referencing inside it first.
147                 lit_text = nodes.literal(classes=['xref', 'c', 'c-func'])
156                 # work around that by ignoring them.
173                  RE_function: 'c-func',
174                  RE_generic_type: 'c-type',
176                  RE_struct: 'c-struct',
177                  RE_union: 'c-union',
178                  RE_enum: 'c-enum',
179                  RE_typedef: 'c-type',
200     # cross-referencing inside it first.
215                 # work around that by ignoring them.
248     # work around that by ignoring them.
289     # work around that by ignoring them.
336         # avoid adding cross-references to functions that have been explicitly
360     app.connect('doctree-resolved', auto_markup)