From: Jonathan Corbet <corbet@lwn.net>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
"Nícolas F. R. A. Prado" <nfraprado@collabora.com>,
"Jonathan Corbet" <corbet@lwn.net>
Subject: [PATCH v2 2/3] docs: automarkup: Mark up undocumented entities too
Date: Wed, 4 Jun 2025 08:36:44 -0600 [thread overview]
Message-ID: <20250604143645.78367-3-corbet@lwn.net> (raw)
In-Reply-To: <20250604143645.78367-1-corbet@lwn.net>
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.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
v2: Split out the CSS changes into a separate patch
Documentation/sphinx/automarkup.py | 9 +++++++--
1 file 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
--
2.49.0
next prev parent reply other threads:[~2025-06-04 14:37 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-04 14:36 [PATCH v2 0/3] docs: some automarkup improvements Jonathan Corbet
2025-06-04 14:36 ` [PATCH v2 1/3] docs: automarkup: Remove some Sphinx 2 holdovers Jonathan Corbet
2025-06-04 14:56 ` Mauro Carvalho Chehab
2025-06-04 14:36 ` Jonathan Corbet [this message]
2025-06-04 14:57 ` [PATCH v2 2/3] docs: automarkup: Mark up undocumented entities too Mauro Carvalho Chehab
2025-06-04 14:36 ` [PATCH v2 3/3] docs: CSS: make cross-reference links more evident Jonathan Corbet
2025-06-04 14:59 ` Mauro Carvalho Chehab
2025-06-04 22:05 ` [PATCH v2 0/3] docs: some automarkup improvements Nícolas F. R. A. Prado
2025-06-05 3:00 ` Bagas Sanjaya
2025-06-05 16:32 ` Jonathan Corbet
2025-06-06 15:57 ` Nícolas F. R. A. Prado
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250604143645.78367-3-corbet@lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=nfraprado@collabora.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).