[PATCH 00/14] Internalize www.kernel.org/doc cross-reference
Bagas Sanjaya
bagasdotme at gmail.com
Fri Aug 29 06:18:55 PDT 2025
On Fri, Aug 29, 2025 at 03:18:20PM +0300, Jani Nikula wrote:
> FWIW, I'd much prefer using :ref: on rst anchors (that automatically
> pick the link text from the target heading) instead of manually adding
> link texts and file references.
>
> i.e.
>
> .. _some_target:
>
> Heading After Some Target
> =========================
>
> See :ref:`some_target`.
>
> Will generate "See Heading After Some Target".
I did that in patch [14/14], but I had to write out explicit anchor text
considering people reading rst source. When they encounter checkpatch warning
and they'd like to learn about solution by following See: links, they should be
able to locate the actual docs and section mentioned without leaving the
terminal. Before this series, however, they need to click the https link
provided, which leads to relevant docs in docs.kernel.org that its source is
already in Documentation/.
Thanks.
--
An old man doll... just what I always wanted! - Clara
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 228 bytes
Desc: not available
URL: <http://lists.infradead.org/pipermail/linux-mtd/attachments/20250829/588f7731/attachment.sig>
More information about the linux-mtd
mailing list