diff options
| author |   Jonathan Corbet <corbet@lwn.net> | 2025-06-04 08:18:04 -0600 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-06-09 14:43:09 -0600 |
| commit | d6d1df92c25fd51ab9062db28ef17b2baf72d241 (patch) | |
| tree | 3bd63ff4e87d52103a1a10836c740d0e86ac1494 | |
| parent | docs: automarkup: Remove some Sphinx 2 holdovers (diff) | |
| download | wireguard-linux-d6d1df92c25fd51ab9062db28ef17b2baf72d241.tar.xz wireguard-linux-d6d1df92c25fd51ab9062db28ef17b2baf72d241.zip | |
docs: automarkup: Mark up undocumented entities too
The automarkup code generates markup and a cross-reference link for
functions, structs, etc. for which it finds kerneldoc documentation.
Undocumented entities are left untouched; that creates an inconsistent
reading experience and has caused some writers to go to extra measures to
cause the markup to happen.
Mark up detected C entities regardless of whether they are documented.
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/sphinx/automarkup.py | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/sphinx/automarkup.py b/Documentation/sphinx/automarkup.py index 7828aeac92e7..e67eb8e19c22 100644 --- a/Documentation/sphinx/automarkup.py +++ b/Documentation/sphinx/automarkup.py @@ -235,8 +235,13 @@ def add_and_resolve_xref(app, docname, domain, reftype, target, contnode=None): if xref: return xref - - return None + # + # We didn't find the xref; if a container node was supplied, + # mark it as a broken xref + # + if contnode: + contnode.set_class("broken_xref") + return contnode # # Variant of markup_abi_ref() that warns whan a reference is not found |