workflows.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2 00/13] Internalize www.kernel.org/doc cross-references
@ 2025-09-10  2:43 Bagas Sanjaya
  2025-09-10  2:43 ` [PATCH v2 01/13] Documentation: hw-vuln: l1tf: Convert kernel docs external links Bagas Sanjaya
                   ` (12 more replies)
  0 siblings, 13 replies; 16+ messages in thread
From: Bagas Sanjaya @ 2025-09-10  2:43 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Documentation, Linux DAMON,
	Linux Memory Management List, Linux Power Management,
	Linux Block Devices, Linux BPF, Linux Kernel Workflows,
	Linux KASAN, Linux Devicetree, Linux fsverity, Linux MTD,
	Linux DRI Development, Linux Kernel Build System,
	Linux Networking, Linux Sound
  Cc: Thomas Gleixner, Borislav Petkov, Peter Zijlstra, Josh Poimboeuf,
	Pawan Gupta, Jonathan Corbet, SeongJae Park, Andrew Morton,
	David Hildenbrand, Lorenzo Stoakes, Liam R. Howlett,
	Vlastimil Babka, Mike Rapoport, Suren Baghdasaryan, Michal Hocko,
	Huang Rui, Gautham R. Shenoy, Mario Limonciello, Perry Yuan,
	Jens Axboe, Alexei Starovoitov, Daniel Borkmann, Andrii Nakryiko,
	Martin KaFai Lau, Eduard Zingerman, Song Liu, Yonghong Song,
	John Fastabend, KP Singh, Stanislav Fomichev, Hao Luo, Jiri Olsa,
	Dwaipayan Ray, Lukas Bulwahn, Joe Perches, Andrey Ryabinin,
	Alexander Potapenko, Andrey Konovalov, Dmitry Vyukov,
	Vincenzo Frascino, Rob Herring, Krzysztof Kozlowski,
	Conor Dooley, Eric Biggers, tytso, Richard Weinberger,
	Zhihao Cheng, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, David Airlie, Simona Vetter,
	Nathan Chancellor, Nicolas Schier, Ingo Molnar, Will Deacon,
	Boqun Feng, Waiman Long, David S. Miller, Eric Dumazet,
	Jakub Kicinski, Paolo Abeni, Simon Horman, Shay Agroskin,
	Arthur Kiyanovski, David Arinzon, Saeed Bishara, Andrew Lunn,
	Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Ranganath V N, Steve French, Meetakshi Setiya,
	Greg Kroah-Hartman, Martin K. Petersen, Bart Van Assche,
	Thomas Weißschuh, Masahiro Yamada, Mauro Carvalho Chehab,
	Jani Nikula

Cross-references to other docs (so-called internal links) are typically
done following Documentation/doc-guide/sphinx.rst: either simply write
the target docs (preferred) or use :doc: or :ref: reST directives (for
use-cases like having anchor text or cross-referencing sections). In
some places, however, links to https://www.kernel.org/doc are used
instead (outgoing, external links), owing inconsistency as these
requires Internet connection only to see docs that otherwise can be
accessed locally (after building with ``make htmldocs``).

Convert such external links to internal links, while keeping the
original anchor texts using :doc: directive. Note that this does not
cover docs.kernel.org links nor touching Documentation/tools (as docs
containing external links are in manpages).

This series is based on docs-next tree. Maintainers can feel free to
apply any of patches in this series to their own tree.

Changes since v1 [1]:

  * Apply review tags
  * Drop patch [12/14] as it has been applied to sound tree

[1]: https://lore.kernel.org/linux-doc/20250829075524.45635-1-bagasdotme@gmail.com/

Bagas Sanjaya (13):
  Documentation: hw-vuln: l1tf: Convert kernel docs external links
  Documentation: damon: reclaim: Convert "Free Page Reporting" citation
    link
  Documentation: perf-security: Convert security credentials
    bibliography link
  Documentation: amd-pstate: Use internal link to kselftest
  Documentation: blk-mq: Convert block layer docs external links
  Documentation: bpf: Convert external kernel docs link
  Documentation: kasan: Use internal link to kunit
  Documentation: gpu: Use internal link to kunit
  Documentation: filesystems: Fix stale reference to device-mapper docs
  Documentation: smb: smbdirect: Convert KSMBD docs link
  Documentation: net: Convert external kernel networking docs
  nitro_enclaves: Use internal cross-reference for kernel docs links
  Documentation: checkpatch: Convert kernel docs references

 Documentation/admin-guide/hw-vuln/l1tf.rst    |   9 +-
 .../admin-guide/mm/damon/reclaim.rst          |   2 +-
 Documentation/admin-guide/perf-security.rst   |   2 +-
 Documentation/admin-guide/pm/amd-pstate.rst   |   3 +-
 Documentation/block/blk-mq.rst                |  23 ++--
 Documentation/bpf/bpf_iterators.rst           |   3 +-
 Documentation/bpf/map_xskmap.rst              |   5 +-
 Documentation/dev-tools/checkpatch.rst        | 121 ++++++++++++------
 Documentation/dev-tools/kasan.rst             |   6 +-
 .../bindings/submitting-patches.rst           |   2 +
 .../driver-api/driver-model/device.rst        |   2 +
 Documentation/filesystems/fsverity.rst        |  11 +-
 Documentation/filesystems/smb/smbdirect.rst   |   4 +-
 Documentation/filesystems/sysfs.rst           |   2 +
 .../filesystems/ubifs-authentication.rst      |   4 +-
 Documentation/gpu/todo.rst                    |   6 +-
 Documentation/kbuild/reproducible-builds.rst  |   2 +
 Documentation/locking/lockdep-design.rst      |   2 +
 .../can/ctu/ctucanfd-driver.rst               |   3 +-
 .../device_drivers/ethernet/amazon/ena.rst    |   4 +-
 Documentation/networking/ethtool-netlink.rst  |   3 +-
 Documentation/networking/snmp_counter.rst     |  12 +-
 Documentation/process/coding-style.rst        |  15 +++
 Documentation/process/deprecated.rst          |   4 +
 Documentation/process/submitting-patches.rst  |   4 +
 Documentation/virt/ne_overview.rst            |  10 +-
 26 files changed, 161 insertions(+), 103 deletions(-)


base-commit: f44a29784f685804d9970cfb0d3439c9e30981d7
-- 
An old man doll... just what I always wanted! - Clara


^ permalink raw reply	[flat|nested] 16+ messages in thread

end of thread, other threads:[~2025-09-11  9:26 UTC | newest]

Thread overview: 16+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-09-10  2:43 [PATCH v2 00/13] Internalize www.kernel.org/doc cross-references Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 01/13] Documentation: hw-vuln: l1tf: Convert kernel docs external links Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 02/13] Documentation: damon: reclaim: Convert "Free Page Reporting" citation link Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 03/13] Documentation: perf-security: Convert security credentials bibliography link Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 04/13] Documentation: amd-pstate: Use internal link to kselftest Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 05/13] Documentation: blk-mq: Convert block layer docs external links Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 06/13] Documentation: bpf: Convert external kernel docs link Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 07/13] Documentation: kasan: Use internal link to kunit Bagas Sanjaya
2025-09-11  9:17   ` Alexander Potapenko
2025-09-10  2:43 ` [PATCH v2 08/13] Documentation: gpu: " Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 09/13] Documentation: filesystems: Fix stale reference to device-mapper docs Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 10/13] Documentation: smb: smbdirect: Convert KSMBD docs link Bagas Sanjaya
2025-09-11  9:26   ` [EXTERNAL] " Meetakshi Setiya
2025-09-10  2:43 ` [PATCH v2 11/13] Documentation: net: Convert external kernel networking docs Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 12/13] nitro_enclaves: Use internal cross-reference for kernel docs links Bagas Sanjaya
2025-09-10  2:43 ` [PATCH v2 13/13] Documentation: checkpatch: Convert kernel docs references Bagas Sanjaya

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox