diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2025-08-22 16:19:17 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-08-29 15:54:42 -0600 |
| commit | 37497a4dc5ecd40f861fad3a436978394d1e97fa (patch) | |
| tree | 2f826cc71474d313289090b11b55f0b21d67090b /Documentation/sphinx | |
| parent | 285b8d3db2bae79c01d604701c3faddb456aca93 (diff) | |
docs: parse-headers.py: simplify the rules for hashes
Normal :ref domain accept either hashes or underscores, but
c-domain ones don't. Fix it and remove unneeded places where
we opt to disable underscore transformation.
Ideally, we should have a rule about the default, or change
the way media docs have their references.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/0c011090272f7a1068545409222f970ddb1ed431.1755872208.git.mchehab+huawei@kernel.org
Diffstat (limited to 'Documentation/sphinx')
| -rwxr-xr-x | Documentation/sphinx/parse-headers.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/Documentation/sphinx/parse-headers.py b/Documentation/sphinx/parse-headers.py index f4ab9c49d2f5..344090ef259c 100755 --- a/Documentation/sphinx/parse-headers.py +++ b/Documentation/sphinx/parse-headers.py @@ -162,7 +162,8 @@ class ParseHeader: if not ref_name: ref_name = symbol.lower() - if replace_underscores: + # c-type references don't support hash + if ref_type == ":ref" and replace_underscores: ref_name = ref_name.replace("_", "-") ref_link = f"{ref_type}:`{symbol} <{ref_name}>`" @@ -258,8 +259,7 @@ class ParseHeader: if match: name = match.group(2).strip() symbol = match.group(3) - self.store_type("typedef", symbol, ref_name=name, - replace_underscores=False) + self.store_type("typedef", symbol, ref_name=name) continue for re_enum in self.RE_ENUMS: @@ -272,8 +272,7 @@ class ParseHeader: for re_struct in self.RE_STRUCTS: match = re_struct.match(line) if match: - self.store_type("struct", match.group(1), - replace_underscores=False) + self.store_type("struct", match.group(1)) break def process_exceptions(self, fname: str): |