From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Jani Nikula <jani.nikula@intel.com>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux DAMON <damon@lists.linux.dev>,
Linux Memory Management List <linux-mm@kvack.org>,
Linux Power Management <linux-pm@vger.kernel.org>,
Linux Block Devices <linux-block@vger.kernel.org>,
Linux BPF <bpf@vger.kernel.org>,
Linux Kernel Workflows <workflows@vger.kernel.org>,
Linux KASAN <kasan-dev@googlegroups.com>,
Linux Devicetree <devicetree@vger.kernel.org>,
Linux fsverity <fsverity@lists.linux.dev>,
Linux MTD <linux-mtd@lists.infradead.org>,
Linux DRI Development <dri-devel@lists.freedesktop.org>,
Linux Kernel Build System <linux-lbuild@vger.kernel.org>,
Linux Networking <netdev@vger.kernel.org>,
Linux Sound <linux-sound@vger.kernel.org>
Cc: "Thomas Gleixner" <tglx@linutronix.de>,
"Borislav Petkov" <bp@alien8.de>,
"Peter Zijlstra" <peterz@infradead.org>,
"Josh Poimboeuf" <jpoimboe@kernel.org>,
"Pawan Gupta" <pawan.kumar.gupta@linux.intel.com>,
"Jonathan Corbet" <corbet@lwn.net>,
"SeongJae Park" <sj@kernel.org>,
"Andrew Morton" <akpm@linux-foundation.org>,
"David Hildenbrand" <david@redhat.com>,
"Lorenzo Stoakes" <lorenzo.stoakes@oracle.com>,
"Liam R. Howlett" <Liam.Howlett@oracle.com>,
"Vlastimil Babka" <vbabka@suse.cz>,
"Mike Rapoport" <rppt@kernel.org>,
"Suren Baghdasaryan" <surenb@google.com>,
"Michal Hocko" <mhocko@suse.com>, "Huang Rui" <ray.huang@amd.com>,
"Gautham R. Shenoy" <gautham.shenoy@amd.com>,
"Mario Limonciello" <mario.limonciello@amd.com>,
"Perry Yuan" <perry.yuan@amd.com>, "Jens Axboe" <axboe@kernel.dk>,
"Alexei Starovoitov" <ast@kernel.org>,
"Daniel Borkmann" <daniel@iogearbox.net>,
"Andrii Nakryiko" <andrii@kernel.org>,
"Martin KaFai Lau" <martin.lau@linux.dev>,
"Eduard Zingerman" <eddyz87@gmail.com>,
"Song Liu" <song@kernel.org>,
"Yonghong Song" <yonghong.song@linux.dev>,
"John Fastabend" <john.fastabend@gmail.com>,
"KP Singh" <kpsingh@kernel.org>,
"Stanislav Fomichev" <sdf@fomichev.me>,
"Hao Luo" <haoluo@google.com>, "Jiri Olsa" <jolsa@kernel.org>,
"Dwaipayan Ray" <dwaipayanray1@gmail.com>,
"Lukas Bulwahn" <lukas.bulwahn@gmail.com>,
"Joe Perches" <joe@perches.com>,
"Andrey Ryabinin" <ryabinin.a.a@gmail.com>,
"Alexander Potapenko" <glider@google.com>,
"Andrey Konovalov" <andreyknvl@gmail.com>,
"Dmitry Vyukov" <dvyukov@google.com>,
"Vincenzo Frascino" <vincenzo.frascino@arm.com>,
"Rob Herring" <robh@kernel.org>,
"Krzysztof Kozlowski" <krzk+dt@kernel.org>,
"Conor Dooley" <conor+dt@kernel.org>,
"Eric Biggers" <ebiggers@kernel.org>,
tytso@mit.edu, "Richard Weinberger" <richard@nod.at>,
"Zhihao Cheng" <chengzhihao1@huawei.com>,
"David Airlie" <airlied@gmail.com>,
"Simona Vetter" <simona@ffwll.ch>,
"Maarten Lankhorst" <maarten.lankhorst@linux.intel.com>,
"Maxime Ripard" <mripard@kernel.org>,
"Thomas Zimmermann" <tzimmermann@suse.de>,
"Nathan Chancellor" <nathan@kernel.org>,
"Nicolas Schier" <nicolas.schier@linux.dev>,
"Ingo Molnar" <mingo@redhat.com>, "Will Deacon" <will@kernel.org>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Waiman Long" <longman@redhat.com>,
"David S. Miller" <davem@davemloft.net>,
"Eric Dumazet" <edumazet@google.com>,
"Jakub Kicinski" <kuba@kernel.org>,
"Paolo Abeni" <pabeni@redhat.com>,
"Simon Horman" <horms@kernel.org>,
"Shay Agroskin" <shayagr@amazon.com>,
"Arthur Kiyanovski" <akiyano@amazon.com>,
"David Arinzon" <darinzon@amazon.com>,
"Saeed Bishara" <saeedb@amazon.com>,
"Andrew Lunn" <andrew@lunn.ch>,
"Liam Girdwood" <lgirdwood@gmail.com>,
"Mark Brown" <broonie@kernel.org>,
"Jaroslav Kysela" <perex@perex.cz>,
"Takashi Iwai" <tiwai@suse.com>,
"Alexandru Ciobotaru" <alcioa@amazon.com>,
"The AWS Nitro Enclaves Team"
<aws-nitro-enclaves-devel@amazon.com>,
"Jesper Dangaard Brouer" <hawk@kernel.org>,
"Laurent Pinchart" <laurent.pinchart@ideasonboard.com>,
"Steve French" <stfrench@microsoft.com>,
"Meetakshi Setiya" <msetiya@microsoft.com>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
"Bart Van Assche" <bvanassche@acm.org>,
"Thomas Weißschuh" <linux@weissschuh.net>,
"Masahiro Yamada" <masahiroy@kernel.org>
Subject: Re: [PATCH 00/14] Internalize www.kernel.org/doc cross-reference
Date: Fri, 29 Aug 2025 20:18:55 +0700 [thread overview]
Message-ID: <aLGovx7OpL_85YTf@archie.me> (raw)
In-Reply-To: <437912a24e94673c2355a2b7b50c3c4b6f68fcc6@intel.com>
[-- Attachment #1: Type: text/plain, Size: 989 bytes --]
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
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next prev parent reply other threads:[~2025-08-29 15:06 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-29 7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 01/14] Documentation: hw-vuln: l1tf: Convert kernel docs external links Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 02/14] Documentation: damon: reclaim: Convert "Free Page Reporting" citation link Bagas Sanjaya
2025-08-29 15:36 ` SeongJae Park
2025-08-29 7:55 ` [PATCH 03/14] Documentation: perf-security: Convert security credentials bibliography link Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 04/14] Documentation: amd-pstate: Use internal link to kselftest Bagas Sanjaya
2025-09-03 3:32 ` Mario Limonciello
2025-08-29 7:55 ` [PATCH 05/14] Documentation: blk-mq: Convert block layer docs external links Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 06/14] Documentation: bpf: Convert external kernel docs link Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 07/14] Documentation: kasan: Use internal link to kunit Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 08/14] Documentation: gpu: " Bagas Sanjaya
2025-08-29 12:00 ` Thomas Zimmermann
2025-08-29 7:55 ` [PATCH 09/14] Documentation: filesystems: Fix stale reference to device-mapper docs Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 10/14] Documentation: smb: smbdirect: Convert KSMBD docs link Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 11/14] Documentation: net: Convert external kernel networking docs Bagas Sanjaya
2025-08-29 16:29 ` Kiyanovski, Arthur
2025-08-29 7:55 ` [PATCH 12/14] ASoC: doc: Internally link to Writing an ALSA Driver docs Bagas Sanjaya
2025-08-30 20:46 ` Mauro Carvalho Chehab
2025-08-30 23:11 ` Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 13/14] nitro_enclaves: Use internal cross-reference for kernel docs links Bagas Sanjaya
2025-08-29 7:55 ` [PATCH 14/14] Documentation: checkpatch: Convert kernel docs references Bagas Sanjaya
2025-08-29 12:18 ` [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Jani Nikula
2025-08-29 13:18 ` Bagas Sanjaya [this message]
2025-08-29 22:19 ` (subset) " Mark Brown
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=aLGovx7OpL_85YTf@archie.me \
--to=bagasdotme@gmail.com \
--cc=Liam.Howlett@oracle.com \
--cc=airlied@gmail.com \
--cc=akiyano@amazon.com \
--cc=akpm@linux-foundation.org \
--cc=alcioa@amazon.com \
--cc=andrew@lunn.ch \
--cc=andreyknvl@gmail.com \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=aws-nitro-enclaves-devel@amazon.com \
--cc=axboe@kernel.dk \
--cc=boqun.feng@gmail.com \
--cc=bp@alien8.de \
--cc=bpf@vger.kernel.org \
--cc=broonie@kernel.org \
--cc=bvanassche@acm.org \
--cc=chengzhihao1@huawei.com \
--cc=conor+dt@kernel.org \
--cc=corbet@lwn.net \
--cc=damon@lists.linux.dev \
--cc=daniel@iogearbox.net \
--cc=darinzon@amazon.com \
--cc=davem@davemloft.net \
--cc=david@redhat.com \
--cc=devicetree@vger.kernel.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=dvyukov@google.com \
--cc=dwaipayanray1@gmail.com \
--cc=ebiggers@kernel.org \
--cc=eddyz87@gmail.com \
--cc=edumazet@google.com \
--cc=fsverity@lists.linux.dev \
--cc=gautham.shenoy@amd.com \
--cc=glider@google.com \
--cc=gregkh@linuxfoundation.org \
--cc=haoluo@google.com \
--cc=hawk@kernel.org \
--cc=horms@kernel.org \
--cc=jani.nikula@intel.com \
--cc=joe@perches.com \
--cc=john.fastabend@gmail.com \
--cc=jolsa@kernel.org \
--cc=jpoimboe@kernel.org \
--cc=kasan-dev@googlegroups.com \
--cc=kpsingh@kernel.org \
--cc=krzk+dt@kernel.org \
--cc=kuba@kernel.org \
--cc=laurent.pinchart@ideasonboard.com \
--cc=lgirdwood@gmail.com \
--cc=linux-block@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-lbuild@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=linux-mtd@lists.infradead.org \
--cc=linux-pm@vger.kernel.org \
--cc=linux-sound@vger.kernel.org \
--cc=linux@weissschuh.net \
--cc=longman@redhat.com \
--cc=lorenzo.stoakes@oracle.com \
--cc=lukas.bulwahn@gmail.com \
--cc=maarten.lankhorst@linux.intel.com \
--cc=mario.limonciello@amd.com \
--cc=martin.lau@linux.dev \
--cc=martin.petersen@oracle.com \
--cc=masahiroy@kernel.org \
--cc=mhocko@suse.com \
--cc=mingo@redhat.com \
--cc=mripard@kernel.org \
--cc=msetiya@microsoft.com \
--cc=nathan@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=nicolas.schier@linux.dev \
--cc=pabeni@redhat.com \
--cc=pawan.kumar.gupta@linux.intel.com \
--cc=perex@perex.cz \
--cc=perry.yuan@amd.com \
--cc=peterz@infradead.org \
--cc=ray.huang@amd.com \
--cc=richard@nod.at \
--cc=robh@kernel.org \
--cc=rppt@kernel.org \
--cc=ryabinin.a.a@gmail.com \
--cc=saeedb@amazon.com \
--cc=sdf@fomichev.me \
--cc=shayagr@amazon.com \
--cc=simona@ffwll.ch \
--cc=sj@kernel.org \
--cc=song@kernel.org \
--cc=stfrench@microsoft.com \
--cc=surenb@google.com \
--cc=tglx@linutronix.de \
--cc=tiwai@suse.com \
--cc=tytso@mit.edu \
--cc=tzimmermann@suse.de \
--cc=vbabka@suse.cz \
--cc=vincenzo.frascino@arm.com \
--cc=will@kernel.org \
--cc=workflows@vger.kernel.org \
--cc=yonghong.song@linux.dev \
/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).