Documentation/sphinx/automarkup.py

1 # SPDX-License-Identifier: GPL-2.0
4 # Apply kernel-specific tweaks after the initial document processing
29 RE_function = re.compile(r'\b(([a-zA-Z_]\w+)\(\))', flags=ascii_p3)
34 RE_generic_type = re.compile(r'\b(struct|union|enum|typedef)\s+([a-zA-Z_]\w+)',
41 RE_struct = re.compile(r'\b(struct)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
42 RE_union = re.compile(r'\b(union)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
43 RE_enum = re.compile(r'\b(enum)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
44 RE_typedef = re.compile(r'\b(typedef)\s+([a-zA-Z_]\w+)', flags=ascii_p3)
50 RE_doc = re.compile(r'(\bDocumentation/)?((\.\./)*[\w\-/]+)\.(rst|txt)')
55 # Reserved C words that we should skip when cross-referencing
62 # pointless to try to cross-reference them and, as has been known
76 RE_git = re.compile(r'commit\s+(?P<rev>[0-9a-f]{12,40})(?:\s+\(".*?"\))?',
127 # Keep track of cross-reference lookups that failed so we don't have to
137 # In sphinx3 we can cross-reference to C macro and function, each one with its
150     # cross-referencing inside it first.
157                 lit_text = nodes.literal(classes=['xref', 'c', 'c-func'])
166                 # work around that by ignoring them.
183                  RE_function: 'c-func',
184                  RE_generic_type: 'c-type',
186                  RE_struct: 'c-struct',
187                  RE_union: 'c-union',
188                  RE_enum: 'c-enum',
189                  RE_typedef: 'c-type',
210     # cross-referencing inside it first.
225                 # work around that by ignoring them.
258     # work around that by ignoring them.
298         # avoid adding cross-references to functions that have been explicitly
322     app.connect('doctree-resolved', auto_markup)