netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 00/14] Internalize www.kernel.org/doc cross-reference
@ 2025-08-29  7:55 Bagas Sanjaya
  2025-08-29  7:55 ` [PATCH 01/14] Documentation: hw-vuln: l1tf: Convert kernel docs external links Bagas Sanjaya
                   ` (15 more replies)
  0 siblings, 16 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

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. 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.

Bagas Sanjaya (14):
  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
  ASoC: doc: Internally link to Writing an ALSA Driver 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/sound/soc/codec.rst             |   4 +-
 Documentation/sound/soc/platform.rst          |   4 +-
 Documentation/virt/ne_overview.rst            |  10 +-
 28 files changed, 165 insertions(+), 107 deletions(-)


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


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

* [PATCH 01/14] Documentation: hw-vuln: l1tf: Convert kernel docs external links
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
@ 2025-08-29  7:55 ` Bagas Sanjaya
  2025-08-29  7:55 ` [PATCH 02/14] Documentation: damon: reclaim: Convert "Free Page Reporting" citation link Bagas Sanjaya
                   ` (14 subsequent siblings)
  15 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Convert external links to kernel docs to use internal cross-references.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/admin-guide/hw-vuln/l1tf.rst | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

diff --git a/Documentation/admin-guide/hw-vuln/l1tf.rst b/Documentation/admin-guide/hw-vuln/l1tf.rst
index 3eeeb488d95527..60bfabbf0b6e2d 100644
--- a/Documentation/admin-guide/hw-vuln/l1tf.rst
+++ b/Documentation/admin-guide/hw-vuln/l1tf.rst
@@ -239,9 +239,8 @@ Guest mitigation mechanisms
    scenarios.
 
    For further information about confining guests to a single or to a group
-   of cores consult the cpusets documentation:
-
-   https://www.kernel.org/doc/Documentation/admin-guide/cgroup-v1/cpusets.rst
+   of cores consult the :doc:`cgroup cpusets documentation
+   <../cgroup-v1/cpusets>`.
 
 .. _interrupt_isolation:
 
@@ -266,9 +265,7 @@ Guest mitigation mechanisms
 
    Interrupt affinity can be controlled by the administrator via the
    /proc/irq/$NR/smp_affinity[_list] files. Limited documentation is
-   available at:
-
-   https://www.kernel.org/doc/Documentation/core-api/irq/irq-affinity.rst
+   available at Documentation/core-api/irq/irq-affinity.rst.
 
 .. _smt_control:
 
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 02/14] Documentation: damon: reclaim: Convert "Free Page Reporting" citation link
  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 ` 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
                   ` (13 subsequent siblings)
  15 siblings, 1 reply; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Use internal cross-reference for the citation link to Free Page
Reporting docs.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/admin-guide/mm/damon/reclaim.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/mm/damon/reclaim.rst b/Documentation/admin-guide/mm/damon/reclaim.rst
index af05ae6170184f..92bb7cf1b5587a 100644
--- a/Documentation/admin-guide/mm/damon/reclaim.rst
+++ b/Documentation/admin-guide/mm/damon/reclaim.rst
@@ -298,4 +298,4 @@ granularity reclamation. ::
 
 .. [1] https://research.google/pubs/pub48551/
 .. [2] https://lwn.net/Articles/787611/
-.. [3] https://www.kernel.org/doc/html/latest/mm/free_page_reporting.html
+.. [3] Documentation/mm/free_page_reporting.rst
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 03/14] Documentation: perf-security: Convert security credentials bibliography link
  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  7:55 ` Bagas Sanjaya
  2025-08-29  7:55 ` [PATCH 04/14] Documentation: amd-pstate: Use internal link to kselftest Bagas Sanjaya
                   ` (12 subsequent siblings)
  15 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Use internal cross-reference for bibliography link to security
credentials docs.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/admin-guide/perf-security.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/perf-security.rst b/Documentation/admin-guide/perf-security.rst
index 34aa334320cad3..ec308e00771427 100644
--- a/Documentation/admin-guide/perf-security.rst
+++ b/Documentation/admin-guide/perf-security.rst
@@ -311,7 +311,7 @@ Bibliography
 .. [2] `<http://man7.org/linux/man-pages/man2/perf_event_open.2.html>`_
 .. [3] `<http://web.eece.maine.edu/~vweaver/projects/perf_events/>`_
 .. [4] `<https://perf.wiki.kernel.org/index.php/Main_Page>`_
-.. [5] `<https://www.kernel.org/doc/html/latest/security/credentials.html>`_
+.. [5] Documentation/security/credentials.rst
 .. [6] `<http://man7.org/linux/man-pages/man7/capabilities.7.html>`_
 .. [7] `<http://man7.org/linux/man-pages/man2/ptrace.2.html>`_
 .. [8] `<https://en.wikipedia.org/wiki/Hardware_performance_counter>`_
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 04/14] Documentation: amd-pstate: Use internal link to kselftest
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (2 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 03/14] Documentation: perf-security: Convert security credentials bibliography link Bagas Sanjaya
@ 2025-08-29  7:55 ` 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
                   ` (11 subsequent siblings)
  15 siblings, 1 reply; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Convert kselftest docs link to internal cross-reference.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/admin-guide/pm/amd-pstate.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
index e1771f2225d5f0..37082f2493a7c1 100644
--- a/Documentation/admin-guide/pm/amd-pstate.rst
+++ b/Documentation/admin-guide/pm/amd-pstate.rst
@@ -798,5 +798,4 @@ Reference
 .. [3] Processor Programming Reference (PPR) for AMD Family 19h Model 51h, Revision A1 Processors
        https://www.amd.com/system/files/TechDocs/56569-A1-PUB.zip
 
-.. [4] Linux Kernel Selftests,
-       https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
+.. [4] Documentation/dev-tools/kselftest.rst
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 05/14] Documentation: blk-mq: Convert block layer docs external links
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (3 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 04/14] Documentation: amd-pstate: Use internal link to kselftest Bagas Sanjaya
@ 2025-08-29  7:55 ` Bagas Sanjaya
  2025-08-29  7:55 ` [PATCH 06/14] Documentation: bpf: Convert external kernel docs link Bagas Sanjaya
                   ` (10 subsequent siblings)
  15 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Convert external links to block layer docs to use internal linking.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/block/blk-mq.rst | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

diff --git a/Documentation/block/blk-mq.rst b/Documentation/block/blk-mq.rst
index fc06761b6ea906..4d511feda39cfd 100644
--- a/Documentation/block/blk-mq.rst
+++ b/Documentation/block/blk-mq.rst
@@ -87,17 +87,16 @@ IO Schedulers
 There are several schedulers implemented by the block layer, each one following
 a heuristic to improve the IO performance. They are "pluggable" (as in plug
 and play), in the sense of they can be selected at run time using sysfs. You
-can read more about Linux's IO schedulers `here
-<https://www.kernel.org/doc/html/latest/block/index.html>`_. The scheduling
-happens only between requests in the same queue, so it is not possible to merge
-requests from different queues, otherwise there would be cache trashing and a
-need to have a lock for each queue. After the scheduling, the requests are
-eligible to be sent to the hardware. One of the possible schedulers to be
-selected is the NONE scheduler, the most straightforward one. It will just
-place requests on whatever software queue the process is running on, without
-any reordering. When the device starts processing requests in the hardware
-queue (a.k.a. run the hardware queue), the software queues mapped to that
-hardware queue will be drained in sequence according to their mapping.
+can read more about Linux's IO schedulers at Documentation/block/index.rst.
+The scheduling happens only between requests in the same queue, so it is not
+possible to merge requests from different queues, otherwise there would be
+cache trashing and a need to have a lock for each queue. After the scheduling,
+the requests are eligible to be sent to the hardware. One of the possible
+schedulers to be selected is the NONE scheduler, the most straightforward one.
+It will just place requests on whatever software queue the process is running
+on, without any reordering. When the device starts processing requests in the
+hardware queue (a.k.a. run the hardware queue), the software queues mapped to
+that hardware queue will be drained in sequence according to their mapping.
 
 Hardware dispatch queues
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -143,7 +142,7 @@ Further reading
 
 - `NOOP scheduler <https://en.wikipedia.org/wiki/Noop_scheduler>`_
 
-- `Null block device driver <https://www.kernel.org/doc/html/latest/block/null_blk.html>`_
+- Documentation/block/null_blk.rst
 
 Source code documentation
 =========================
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 06/14] Documentation: bpf: Convert external kernel docs link
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (4 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 05/14] Documentation: blk-mq: Convert block layer docs external links Bagas Sanjaya
@ 2025-08-29  7:55 ` Bagas Sanjaya
  2025-08-29  7:55 ` [PATCH 07/14] Documentation: kasan: Use internal link to kunit Bagas Sanjaya
                   ` (9 subsequent siblings)
  15 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Convert links to other docs pages that use external links into
internal cross-references.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/bpf/bpf_iterators.rst | 3 +--
 Documentation/bpf/map_xskmap.rst    | 5 ++---
 2 files changed, 3 insertions(+), 5 deletions(-)

diff --git a/Documentation/bpf/bpf_iterators.rst b/Documentation/bpf/bpf_iterators.rst
index 189e3ec1c6c8e0..c8e68268fb3e76 100644
--- a/Documentation/bpf/bpf_iterators.rst
+++ b/Documentation/bpf/bpf_iterators.rst
@@ -123,8 +123,7 @@ which often takes time to publish upstream and release. The same is true for pop
 tools like `ss <https://man7.org/linux/man-pages/man8/ss.8.html>`_ where any
 additional information needs a kernel patch.
 
-To solve this problem, the `drgn
-<https://www.kernel.org/doc/html/latest/bpf/drgn.html>`_ tool is often used to
+To solve this problem, the :doc:`drgn <drgn>` tool is often used to
 dig out the kernel data with no kernel change. However, the main drawback for
 drgn is performance, as it cannot do pointer tracing inside the kernel. In
 addition, drgn cannot validate a pointer value and may read invalid data if the
diff --git a/Documentation/bpf/map_xskmap.rst b/Documentation/bpf/map_xskmap.rst
index dc143edd923393..58562e37c16a01 100644
--- a/Documentation/bpf/map_xskmap.rst
+++ b/Documentation/bpf/map_xskmap.rst
@@ -10,7 +10,7 @@ BPF_MAP_TYPE_XSKMAP
 
 The ``BPF_MAP_TYPE_XSKMAP`` is used as a backend map for XDP BPF helper
 call ``bpf_redirect_map()`` and ``XDP_REDIRECT`` action, like 'devmap' and 'cpumap'.
-This map type redirects raw XDP frames to `AF_XDP`_ sockets (XSKs), a new type of
+This map type redirects raw XDP frames to AF_XDP sockets (XSKs), a new type of
 address family in the kernel that allows redirection of frames from a driver to
 user space without having to traverse the full network stack. An AF_XDP socket
 binds to a single netdev queue. A mapping of XSKs to queues is shown below:
@@ -181,12 +181,11 @@ AF_XDP-forwarding programs in the `bpf-examples`_ directory in the `libxdp`_ rep
 For a detailed explanation of the AF_XDP interface please see:
 
 - `libxdp-readme`_.
-- `AF_XDP`_ kernel documentation.
+- Documentation/networking/af_xdp.rst.
 
 .. note::
     The most comprehensive resource for using XSKMAPs and AF_XDP is `libxdp`_.
 
 .. _libxdp: https://github.com/xdp-project/xdp-tools/tree/master/lib/libxdp
-.. _AF_XDP: https://www.kernel.org/doc/html/latest/networking/af_xdp.html
 .. _bpf-examples: https://github.com/xdp-project/bpf-examples
 .. _libxdp-readme: https://github.com/xdp-project/xdp-tools/tree/master/lib/libxdp#using-af_xdp-sockets
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 07/14] Documentation: kasan: Use internal link to kunit
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (5 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 06/14] Documentation: bpf: Convert external kernel docs link Bagas Sanjaya
@ 2025-08-29  7:55 ` Bagas Sanjaya
  2025-08-29  7:55 ` [PATCH 08/14] Documentation: gpu: " Bagas Sanjaya
                   ` (8 subsequent siblings)
  15 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Use internal linking to KUnit documentation.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/dev-tools/kasan.rst | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/Documentation/dev-tools/kasan.rst b/Documentation/dev-tools/kasan.rst
index 0a1418ab72fdfc..c0896d55c97af8 100644
--- a/Documentation/dev-tools/kasan.rst
+++ b/Documentation/dev-tools/kasan.rst
@@ -562,7 +562,5 @@ There are a few ways to run the KASAN tests.
    With ``CONFIG_KUNIT`` and ``CONFIG_KASAN_KUNIT_TEST`` built-in, it is also
    possible to use ``kunit_tool`` to see the results of KUnit tests in a more
    readable way. This will not print the KASAN reports of the tests that passed.
-   See `KUnit documentation <https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html>`_
-   for more up-to-date information on ``kunit_tool``.
-
-.. _KUnit: https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html
+   See :doc:`KUnit documentation <kunit/index>` for more up-to-date information
+   on ``kunit_tool``.
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 08/14] Documentation: gpu: Use internal link to kunit
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (6 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 07/14] Documentation: kasan: Use internal link to kunit Bagas Sanjaya
@ 2025-08-29  7:55 ` 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
                   ` (7 subsequent siblings)
  15 siblings, 1 reply; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Use internal linking to kunit documentation.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/gpu/todo.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst
index be8637da3fe950..efe9393f260ae2 100644
--- a/Documentation/gpu/todo.rst
+++ b/Documentation/gpu/todo.rst
@@ -655,9 +655,9 @@ Better Testing
 Add unit tests using the Kernel Unit Testing (KUnit) framework
 --------------------------------------------------------------
 
-The `KUnit <https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html>`_
-provides a common framework for unit tests within the Linux kernel. Having a
-test suite would allow to identify regressions earlier.
+The :doc:`KUnit </dev-tools/kunit/index>` provides a common framework for unit
+tests within the Linux kernel. Having a test suite would allow to identify
+regressions earlier.
 
 A good candidate for the first unit tests are the format-conversion helpers in
 ``drm_format_helper.c``.
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 09/14] Documentation: filesystems: Fix stale reference to device-mapper docs
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (7 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 08/14] Documentation: gpu: " Bagas Sanjaya
@ 2025-08-29  7:55 ` Bagas Sanjaya
  2025-08-29  7:55 ` [PATCH 10/14] Documentation: smb: smbdirect: Convert KSMBD docs link Bagas Sanjaya
                   ` (6 subsequent siblings)
  15 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Commit 6cf2a73cb2bc42 ("docs: device-mapper: move it to the admin-guide")
moves device mapper docs to Documentation/admin-guide, but left
references (which happen to be external ones) behind, hence 404 when
clicking them.

Fix the references while also converting them to internal ones.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/filesystems/fsverity.rst             | 11 +++++------
 Documentation/filesystems/ubifs-authentication.rst |  4 ++--
 2 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/Documentation/filesystems/fsverity.rst b/Documentation/filesystems/fsverity.rst
index 412cf11e329852..54378a3926de7b 100644
--- a/Documentation/filesystems/fsverity.rst
+++ b/Documentation/filesystems/fsverity.rst
@@ -15,12 +15,11 @@ of read-only files.  Currently, it is supported by the ext4, f2fs, and
 btrfs filesystems.  Like fscrypt, not too much filesystem-specific
 code is needed to support fs-verity.
 
-fs-verity is similar to `dm-verity
-<https://www.kernel.org/doc/Documentation/admin-guide/device-mapper/verity.rst>`_
-but works on files rather than block devices.  On regular files on
-filesystems supporting fs-verity, userspace can execute an ioctl that
-causes the filesystem to build a Merkle tree for the file and persist
-it to a filesystem-specific location associated with the file.
+fs-verity is similar to :doc:`dm-verity
+</admin-guide/device-mapper/verity>` but works on files rather than block
+devices.  On regular files on filesystems supporting fs-verity, userspace can
+execute an ioctl that causes the filesystem to build a Merkle tree for the file
+and persist it to a filesystem-specific location associated with the file.
 
 After this, the file is made readonly, and all reads from the file are
 automatically verified against the file's Merkle tree.  Reads of any
diff --git a/Documentation/filesystems/ubifs-authentication.rst b/Documentation/filesystems/ubifs-authentication.rst
index 106bb9c056f611..9fcad59820915d 100644
--- a/Documentation/filesystems/ubifs-authentication.rst
+++ b/Documentation/filesystems/ubifs-authentication.rst
@@ -439,9 +439,9 @@ References
 
 [DMC-CBC-ATTACK]     https://www.jakoblell.com/blog/2013/12/22/practical-malleability-attack-against-cbc-encrypted-luks-partitions/
 
-[DM-INTEGRITY]       https://www.kernel.org/doc/Documentation/device-mapper/dm-integrity.rst
+[DM-INTEGRITY]       Documentation/admin-guide/device-mapper/dm-integrity.rst
 
-[DM-VERITY]          https://www.kernel.org/doc/Documentation/device-mapper/verity.rst
+[DM-VERITY]          Documentation/admin-guide/device-mapper/verity.rst
 
 [FSCRYPT-POLICY2]    https://lore.kernel.org/r/20171023214058.128121-1-ebiggers3@gmail.com/
 
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 10/14] Documentation: smb: smbdirect: Convert KSMBD docs link
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (8 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 09/14] Documentation: filesystems: Fix stale reference to device-mapper docs Bagas Sanjaya
@ 2025-08-29  7:55 ` Bagas Sanjaya
  2025-08-29  7:55 ` [PATCH 11/14] Documentation: net: Convert external kernel networking docs Bagas Sanjaya
                   ` (5 subsequent siblings)
  15 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Convert KSMBD docs link to internal link.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/filesystems/smb/smbdirect.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/filesystems/smb/smbdirect.rst b/Documentation/filesystems/smb/smbdirect.rst
index ca6927c0b2c084..6258de919511fa 100644
--- a/Documentation/filesystems/smb/smbdirect.rst
+++ b/Documentation/filesystems/smb/smbdirect.rst
@@ -76,8 +76,8 @@ Installation
 Setup and Usage
 ================
 
-- Set up and start a KSMBD server as described in the `KSMBD documentation
-  <https://www.kernel.org/doc/Documentation/filesystems/smb/ksmbd.rst>`_.
+- Set up and start a KSMBD server as described in the :doc:`KSMBD documentation
+  <ksmbd>`.
   Also add the "server multi channel support = yes" parameter to ksmbd.conf.
 
 - On the client, mount the share with `rdma` mount option to use SMB Direct
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 11/14] Documentation: net: Convert external kernel networking docs
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (9 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 10/14] Documentation: smb: smbdirect: Convert KSMBD docs link Bagas Sanjaya
@ 2025-08-29  7:55 ` 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
                   ` (4 subsequent siblings)
  15 siblings, 1 reply; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Convert cross-references to kernel networking docs that use external
links into internal ones.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 .../device_drivers/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 +++++-------
 4 files changed, 9 insertions(+), 13 deletions(-)

diff --git a/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst b/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst
index 1661d13174d5b8..4f9f36414333fd 100644
--- a/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst
+++ b/Documentation/networking/device_drivers/can/ctu/ctucanfd-driver.rst
@@ -40,8 +40,7 @@ About SocketCAN
 SocketCAN is a standard common interface for CAN devices in the Linux
 kernel. As the name suggests, the bus is accessed via sockets, similarly
 to common network devices. The reasoning behind this is in depth
-described in `Linux SocketCAN <https://www.kernel.org/doc/html/latest/networking/can.html>`_.
-In short, it offers a
+described in Documentation/networking/can.rst. In short, it offers a
 natural way to implement and work with higher layer protocols over CAN,
 in the same way as, e.g., UDP/IP over Ethernet.
 
diff --git a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
index 14784a0a6a8a10..b7b314de857b01 100644
--- a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
+++ b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
@@ -366,9 +366,9 @@ RSS
 
 DEVLINK SUPPORT
 ===============
-.. _`devlink`: https://www.kernel.org/doc/html/latest/networking/devlink/index.html
 
-`devlink`_ supports reloading the driver and initiating re-negotiation with the ENA device
+:doc:`devlink </networking/devlink/index>` supports reloading the driver and
+initiating re-negotiation with the ENA device
 
 .. code-block:: shell
 
diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
index ab20c644af2485..3445b575cb5d39 100644
--- a/Documentation/networking/ethtool-netlink.rst
+++ b/Documentation/networking/ethtool-netlink.rst
@@ -1100,8 +1100,7 @@ This feature is mainly of interest for specific USB devices which does not cope
 well with frequent small-sized URBs transmissions.
 
 ``ETHTOOL_A_COALESCE_RX_PROFILE`` and ``ETHTOOL_A_COALESCE_TX_PROFILE`` refer
-to DIM parameters, see `Generic Network Dynamic Interrupt Moderation (Net DIM)
-<https://www.kernel.org/doc/Documentation/networking/net_dim.rst>`_.
+to DIM parameters, see Documentation/networking/net_dim.rst.
 
 COALESCE_SET
 ============
diff --git a/Documentation/networking/snmp_counter.rst b/Documentation/networking/snmp_counter.rst
index ff1e6a8ffe2164..c51d6ca9eff2c7 100644
--- a/Documentation/networking/snmp_counter.rst
+++ b/Documentation/networking/snmp_counter.rst
@@ -782,13 +782,11 @@ TCP ACK skip
 ============
 In some scenarios, kernel would avoid sending duplicate ACKs too
 frequently. Please find more details in the tcp_invalid_ratelimit
-section of the `sysctl document`_. When kernel decides to skip an ACK
-due to tcp_invalid_ratelimit, kernel would update one of below
-counters to indicate the ACK is skipped in which scenario. The ACK
-would only be skipped if the received packet is either a SYN packet or
-it has no data.
-
-.. _sysctl document: https://www.kernel.org/doc/Documentation/networking/ip-sysctl.rst
+section of the Documentation/networking/ip-sysctl.rst. When kernel
+decides to skip an ACK due to tcp_invalid_ratelimit, kernel would
+update one of below counters to indicate the ACK is skipped in
+which scenario. The ACK would only be skipped if the received
+packet is either a SYN packet or it has no data.
 
 * TcpExtTCPACKSkippedSynRecv
 
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 12/14] ASoC: doc: Internally link to Writing an ALSA Driver docs
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (10 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 11/14] Documentation: net: Convert external kernel networking docs Bagas Sanjaya
@ 2025-08-29  7:55 ` Bagas Sanjaya
  2025-08-30 20:46   ` Mauro Carvalho Chehab
  2025-08-29  7:55 ` [PATCH 13/14] nitro_enclaves: Use internal cross-reference for kernel docs links Bagas Sanjaya
                   ` (3 subsequent siblings)
  15 siblings, 1 reply; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

ASoC codec and platform driver docs contain reference to writing ALSA
driver docs, as an external link. Use :doc: directive for the job
instead.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/sound/soc/codec.rst    | 4 ++--
 Documentation/sound/soc/platform.rst | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/sound/soc/codec.rst b/Documentation/sound/soc/codec.rst
index af973c4cac9309..b9d87a4f929b5d 100644
--- a/Documentation/sound/soc/codec.rst
+++ b/Documentation/sound/soc/codec.rst
@@ -131,8 +131,8 @@ The codec driver also supports the following ALSA PCM operations:-
 	int (*prepare)(struct snd_pcm_substream *);
   };
 
-Please refer to the ALSA driver PCM documentation for details.
-https://www.kernel.org/doc/html/latest/sound/kernel-api/writing-an-alsa-driver.html
+Please refer to the :doc:`ALSA driver PCM documentation
+<../kernel-api/writing-an-alsa-driver>` for details.
 
 
 DAPM description
diff --git a/Documentation/sound/soc/platform.rst b/Documentation/sound/soc/platform.rst
index 7036630eaf016c..bd21d0a4dd9b0b 100644
--- a/Documentation/sound/soc/platform.rst
+++ b/Documentation/sound/soc/platform.rst
@@ -45,8 +45,8 @@ snd_soc_component_driver:-
 	...
   };
 
-Please refer to the ALSA driver documentation for details of audio DMA.
-https://www.kernel.org/doc/html/latest/sound/kernel-api/writing-an-alsa-driver.html
+Please refer to the :doc:`ALSA driver documentation
+<../kernel-api/writing-an-alsa-driver>` for details of audio DMA.
 
 An example DMA driver is soc/pxa/pxa2xx-pcm.c
 
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 13/14] nitro_enclaves: Use internal cross-reference for kernel docs links
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (11 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 12/14] ASoC: doc: Internally link to Writing an ALSA Driver docs Bagas Sanjaya
@ 2025-08-29  7:55 ` Bagas Sanjaya
  2025-08-29  7:55 ` [PATCH 14/14] Documentation: checkpatch: Convert kernel docs references Bagas Sanjaya
                   ` (2 subsequent siblings)
  15 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

Convert links to kernel docs pages from external link to internal
cross-references.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/virt/ne_overview.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/virt/ne_overview.rst b/Documentation/virt/ne_overview.rst
index 74c2f5919c886e..572105eab452b2 100644
--- a/Documentation/virt/ne_overview.rst
+++ b/Documentation/virt/ne_overview.rst
@@ -91,10 +91,10 @@ running in the primary VM via a poll notification mechanism. Then the user space
 enclave process can exit.
 
 [1] https://aws.amazon.com/ec2/nitro/nitro-enclaves/
-[2] https://www.kernel.org/doc/html/latest/admin-guide/mm/hugetlbpage.html
+[2] Documentation/admin-guide/mm/hugetlbpage.rst
 [3] https://lwn.net/Articles/807108/
-[4] https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html
+[4] Documentation/admin-guide/kernel-parameters.rst
 [5] https://man7.org/linux/man-pages/man7/vsock.7.html
-[6] https://www.kernel.org/doc/html/latest/x86/boot.html
-[7] https://www.kernel.org/doc/html/latest/arm64/hugetlbpage.html
-[8] https://www.kernel.org/doc/html/latest/arm64/booting.html
+[6] Documentation/arch/x86/boot.rst
+[7] Documentation/arch/arm64/hugetlbpage.rst
+[8] Documentation/arch/arm64/booting.rst
-- 
An old man doll... just what I always wanted! - Clara


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

* [PATCH 14/14] Documentation: checkpatch: Convert kernel docs references
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (12 preceding siblings ...)
  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 ` Bagas Sanjaya
  2025-08-29 12:18 ` [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Jani Nikula
  2025-08-29 22:19 ` (subset) " Mark Brown
  15 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29  7:55 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

checkpatch documentation has pointer references to various style-related
docs. Convert them from external link to internal cross-references.

For reference to docs sections, use section names and reference
docs path as anchor text.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/dev-tools/checkpatch.rst        | 121 ++++++++++++------
 .../bindings/submitting-patches.rst           |   2 +
 .../driver-api/driver-model/device.rst        |   2 +
 Documentation/filesystems/sysfs.rst           |   2 +
 Documentation/kbuild/reproducible-builds.rst  |   2 +
 Documentation/locking/lockdep-design.rst      |   2 +
 Documentation/process/coding-style.rst        |  15 +++
 Documentation/process/deprecated.rst          |   4 +
 Documentation/process/submitting-patches.rst  |   4 +
 9 files changed, 113 insertions(+), 41 deletions(-)

diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index d5c47e560324fb..2ec288d845b81d 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -247,7 +247,7 @@ Allocation style
     number of elements.  sizeof() as the first argument is generally
     wrong.
 
-    See: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.html
+    See: Documentation/core-api/memory-allocation.rst
 
   **ALLOC_SIZEOF_STRUCT**
     The allocation style is bad.  In general for family of
@@ -260,13 +260,14 @@ Allocation style
 
       p = alloc(sizeof(*p), ...)
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#allocating-memory
+    See: :ref:`"Allocating memory" section on Documentation/process/coding-style.rst
+    <memory-allocation-style>`.
 
   **ALLOC_WITH_MULTIPLY**
     Prefer kmalloc_array/kcalloc over kmalloc/kzalloc with a
     sizeof multiply.
 
-    See: https://www.kernel.org/doc/html/latest/core-api/memory-allocation.html
+    See: Documentation/core-api/memory-allocation.rst
 
 
 API usage
@@ -287,7 +288,8 @@ API usage
     Use WARN() and WARN_ON() instead, and handle the "impossible"
     error condition as gracefully as possible.
 
-    See: https://www.kernel.org/doc/html/latest/process/deprecated.html#bug-and-bug-on
+    See: :ref:`"BUG() and BUG_ON()" section on
+    Documentation/process/deprecated.rst <bug-macros-deprecated>`
 
   **CONSIDER_KSTRTO**
     The simple_strtol(), simple_strtoll(), simple_strtoul(), and
@@ -296,7 +298,9 @@ API usage
     kstrtoll(), kstrtoul(), and kstrtoull() functions tend to be the
     correct replacements.
 
-    See: https://www.kernel.org/doc/html/latest/process/deprecated.html#simple-strtol-simple-strtoll-simple-strtoul-simple-strtoull
+    See: :ref:`"simple_strtol(), simple_strtoll(), simple_strtoul(),
+    simple_strtoull() section" on Documentation/process/deprecated.rst
+    <simple-strtol-family-deprecated>`
 
   **CONSTANT_CONVERSION**
     Use of __constant_<foo> form is discouraged for the following functions::
@@ -340,7 +344,8 @@ API usage
 
     The full list of available RCU APIs can be viewed from the kernel docs.
 
-    See: https://www.kernel.org/doc/html/latest/RCU/whatisRCU.html#full-list-of-rcu-apis
+    See: :ref:`"Full list of RCU APIs" section on
+    Documentation/RCU/whatisRCU.rst <8_whatisRCU>`
 
   **DEVICE_ATTR_FUNCTIONS**
     The function names used in DEVICE_ATTR is unusual.
@@ -354,7 +359,8 @@ API usage
 
     The function names should preferably follow the above pattern.
 
-    See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes
+    See: :ref:`"Attributes" section on
+    Documentation/driver-api/driver-model/device.rst <device-attributes>`
 
   **DEVICE_ATTR_RO**
     The DEVICE_ATTR_RO(name) helper macro can be used instead of
@@ -363,7 +369,8 @@ API usage
     Note that the macro automatically appends _show to the named
     attribute variable of the device for the show method.
 
-    See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes
+    See: :ref:`"Attributes" section on
+    Documentation/driver-api/driver-model/device.rst <device-attributes>`
 
   **DEVICE_ATTR_RW**
     The DEVICE_ATTR_RW(name) helper macro can be used instead of
@@ -372,7 +379,8 @@ API usage
     Note that the macro automatically appends _show and _store to the
     named attribute variable of the device for the show and store methods.
 
-    See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes
+    See: :ref:`"Attributes" section on
+    Documentation/driver-api/driver-model/device.rst <device-attributes>`
 
   **DEVICE_ATTR_WO**
     The DEVICE_AATR_WO(name) helper macro can be used instead of
@@ -381,7 +389,8 @@ API usage
     Note that the macro automatically appends _store to the
     named attribute variable of the device for the store method.
 
-    See: https://www.kernel.org/doc/html/latest/driver-api/driver-model/device.html#attributes
+    See: :ref:`"Attributes" section on
+    Documentation/driver-api/driver-model/device.rst <device-attributes>`
 
   **DUPLICATED_SYSCTL_CONST**
     Commit d91bff3011cf ("proc/sysctl: add shared variables for range
@@ -443,7 +452,8 @@ API usage
     lockdep_assert_held() annotations should be preferred over
     assertions based on spin_is_locked()
 
-    See: https://www.kernel.org/doc/html/latest/locking/lockdep-design.html#annotations
+    See: :ref:`"Annotations" section on
+    Documentation/locking/lockdep-design.rst <lockdep-annotations>`
 
   **UAPI_INCLUDE**
     No #include statements in include/uapi should use a uapi/ path.
@@ -472,13 +482,15 @@ Comments
       * for files in net/ and drivers/net/
       */
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting
+    See: :ref:`Commenting section on Documentation/process/coding-style.rst
+    <comments-style>`
 
   **C99_COMMENTS**
     C99 style single line comments (//) should not be used.
     Prefer the block comment style instead.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#commenting
+    See: :ref:`Commenting section on Documentation/process/coding-style.rst
+    <comments-style>`
 
   **DATA_RACE**
     Applications of data_race() should have a comment so as to document the
@@ -512,7 +524,8 @@ Commit message
     The signed-off-by line does not fall in line with the standards
     specified by the community.
 
-    See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#developer-s-certificate-of-origin-1-1
+    See: :ref:`Developer's Certificate of Origin 1.1 text on
+    Documentation/process/submitting-patches.rst <dco-text>`
 
   **BAD_STABLE_ADDRESS_STYLE**
     The email format for stable is incorrect.
@@ -534,14 +547,16 @@ Commit message
     The patch is missing a commit description.  A brief
     description of the changes made by the patch should be added.
 
-    See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
+    See: :ref:`"Describe your changes" section on
+    Documentation/process/submitting-patches.rst <describe_changes>`
 
   **EMAIL_SUBJECT**
     Naming the tool that found the issue is not very useful in the
     subject line.  A good subject line summarizes the change that
     the patch brings.
 
-    See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
+    See: :ref:`"Describe your changes" section on
+    Documentation/process/submitting-patches.rst <describe_changes>`
 
   **FROM_SIGN_OFF_MISMATCH**
     The author's email does not match with that in the Signed-off-by:
@@ -560,7 +575,8 @@ Commit message
     line should be added according to Developer's certificate of
     Origin.
 
-    See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
+    See: :ref:`"Sign your work - the Developer's Certificate of Origin"
+    section on Documentation/process/submitting-patches.rst <dco-signoff>`
 
   **NO_AUTHOR_SIGN_OFF**
     The author of the patch has not signed off the patch.  It is
@@ -569,7 +585,8 @@ Commit message
     written it or otherwise has the rights to pass it on as an open
     source patch.
 
-    See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
+    See: :ref:`"Sign your work - the Developer's Certificate of Origin"
+    section on Documentation/process/submitting-patches.rst <dco-signoff>`
 
   **DIFF_IN_COMMIT_MSG**
     Avoid having diff content in commit message.
@@ -599,14 +616,16 @@ Commit message
       platform_set_drvdata(), but left the variable "dev" unused,
       delete it.
 
-    See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
+    See: :ref:`"Describe your changes" section on
+    Documentation/process/submitting-patches.rst <describe_changes>`
 
   **BAD_FIXES_TAG**
     The Fixes: tag is malformed or does not follow the community conventions.
     This can occur if the tag have been split into multiple lines (e.g., when
     pasted in an email program with word wrapping enabled).
 
-    See: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
+    See: :ref:`"Describe your changes" section on
+    Documentation/process/submitting-patches.rst <describe_changes>`
 
 
 Comparison style
@@ -646,7 +665,8 @@ Indentation and Line Breaks
     Outside of comments, documentation and Kconfig,
     spaces are never used for indentation.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentation
+    See: :ref:`"Indentation" section on Documentation/process/coding-style.rst
+    <indentation-style>`
 
   **DEEP_INDENTATION**
     Indentation with 6 or more tabs usually indicate overly indented
@@ -678,7 +698,8 @@ Indentation and Line Breaks
               break;
       }
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#indentation
+    See: :ref:`"Indentation" section on Documentation/process/coding-style.rst
+    <indentation-style>`
 
   **LONG_LINE**
     The line has exceeded the specified maximum length.
@@ -690,21 +711,24 @@ Indentation and Line Breaks
     limit to 100 columns.  This is not a hard limit either and it's
     preferable to stay within 80 columns whenever possible.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings
+    See: :ref:`"Breaking long lines and strings" section on
+    Documentation/process/coding-style.rst <long-line-break>`
 
   **LONG_LINE_STRING**
     A string starts before but extends beyond the maximum line length.
     To use a different maximum line length, the --max-line-length=n option
     may be added while invoking checkpatch.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings
+    See: :ref:`"Breaking long lines and strings" section on
+    Documentation/process/coding-style.rst <long-line-break>`
 
   **LONG_LINE_COMMENT**
     A comment starts before but extends beyond the maximum line length.
     To use a different maximum line length, the --max-line-length=n option
     may be added while invoking checkpatch.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings
+    See: :ref:`"Breaking long lines and strings" section on
+    Documentation/process/coding-style.rst <long-line-break>`
 
   **SPLIT_STRING**
     Quoted strings that appear as messages in userspace and can be
@@ -803,7 +827,8 @@ Macros, Attributes and Symbols
     and enables warnings if they are used as they can lead to
     non-deterministic builds.
 
-    See: https://www.kernel.org/doc/html/latest/kbuild/reproducible-builds.html#timestamps
+    See: :ref:`"Timestamps" section on
+    Documentation/kbuild/reproducible-builds.rst <kernel-timestamps>`
 
   **DEFINE_ARCH_HAS**
     The ARCH_HAS_xyz and ARCH_HAVE_xyz patterns are wrong.
@@ -868,7 +893,8 @@ Macros, Attributes and Symbols
                         do_this(b, c);          \
         } while (0)
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl
+    See: :ref:`"Macros, Enums and RTL" section on
+    Documentation/process/coding-style.rst <macros-style>`
 
   **PREFER_FALLTHROUGH**
     Use the `fallthrough;` pseudo keyword instead of
@@ -907,7 +933,8 @@ Macros, Attributes and Symbols
 
       WARNING: Argument 'a' is not used in function-like macro.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#macros-enums-and-rtl
+    See: :ref:`"Macros, Enums and RTL" section on
+    Documentation/process/coding-style.rst <macros-style>`
 
   **SINGLE_STATEMENT_DO_WHILE_MACRO**
     For the multi-statement macros, it is necessary to use the do-while
@@ -931,7 +958,8 @@ Functions and Variables
   **CAMELCASE**
     Avoid CamelCase Identifiers.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#naming
+    See: :ref:`"Naming" section on Documentation/process/coding-style.rst
+    <naming-convention>`
 
   **CONST_CONST**
     Using `const <type> const *` is generally meant to be
@@ -1018,7 +1046,8 @@ Permissions
     Typically only three permissions are used - 0644 (RW), 0444 (RO)
     and 0200 (WO).
 
-    See: https://www.kernel.org/doc/html/latest/filesystems/sysfs.html#attributes
+    See: :ref:`"Attributes" section on Documentation/filesystems/sysfs.rst
+    <sysfs-attributes>`
 
   **EXECUTE_PERMISSIONS**
     There is no reason for source files to be executable.  The executable
@@ -1074,7 +1103,8 @@ Spacing and Brackets
               body of function
       }
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces
+    See: :ref:`"Placing Braces and Spaces" section on
+    Documentation/process/coding-style.rst <braces-placement>`
 
   **BRACKET_SPACE**
     Whitespace before opening bracket '[' is prohibited.
@@ -1105,20 +1135,23 @@ Spacing and Brackets
   **ELSE_AFTER_BRACE**
     `else {` should follow the closing block `}` on the same line.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces
+    See: :ref:`"Placing Braces and Spaces" section on
+    Documentation/process/coding-style.rst <braces-placement>`
 
   **LINE_SPACING**
     Vertical space is wasted given the limited number of lines an
     editor window can display when multiple blank lines are used.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces
+    See: :ref:`"Spaces" subsection on Documentation/process/coding-style.rst
+    <spaces-usage>`
 
   **OPEN_BRACE**
     The opening brace should be following the function definitions on the
     next line.  For any non-functional block it should be on the same line
     as the last construct.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces
+    See: :ref:`"Placing Braces and Spaces" section on
+    Documentation/process/coding-style.rst <braces-placement>`
 
   **POINTER_LOCATION**
     When using pointer data or a function that returns a pointer type,
@@ -1130,19 +1163,22 @@ Spacing and Brackets
       unsigned long long memparse(char *ptr, char **retptr);
       char *match_strdup(substring_t *s);
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces
+    See: :ref:`"Spaces" subsection on Documentation/process/coding-style.rst
+    <spaces-usage>`
 
   **SPACING**
     Whitespace style used in the kernel sources is described in kernel docs.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces
+    See: :ref:`"Spaces" subsection on Documentation/process/coding-style.rst
+    <spaces-usage>`
 
   **TRAILING_WHITESPACE**
     Trailing whitespace should always be removed.
     Some editors highlight the trailing whitespace and cause visual
     distractions when editing files.
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#spaces
+    See: :ref:`"Spaces" subsection on Documentation/process/coding-style.rst
+    <spaces-usage>`
 
   **UNNECESSARY_PARENTHESES**
     Parentheses are not required in the following cases:
@@ -1182,7 +1218,8 @@ Spacing and Brackets
               ...
       } while(something);
 
-    See: https://www.kernel.org/doc/html/latest/process/coding-style.html#placing-braces-and-spaces
+    See: :ref:`"Placing Braces and Spaces" section on
+    Documentation/process/coding-style.rst <braces-placement>`
 
 
 Others
@@ -1216,7 +1253,7 @@ Others
     DT bindings moved to a json-schema based format instead of
     freeform text.
 
-    See: https://www.kernel.org/doc/html/latest/devicetree/bindings/writing-schema.html
+    See: Documentation/devicetree/bindings/writing-schema.rst
 
   **DT_SPLIT_BINDING_PATCH**
     Devicetree bindings should be their own patch.  This is because
@@ -1225,7 +1262,9 @@ Others
     are applied via the same tree), and it makes for a cleaner history in the
     DT only tree created with git-filter-branch.
 
-    See: https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html#i-for-patch-submitters
+    See: :ref:`"For patch submitters" section on
+    Documentation/devicetree/bindings/submitting-patches.rst
+    <submitting-dt-patches>`
 
   **EMBEDDED_FILENAME**
     Embedding the complete filename path inside the file isn't particularly
@@ -1253,7 +1292,7 @@ Others
     The Linux kernel requires the precise SPDX identifier in all source files,
     and it is thoroughly documented in the kernel docs.
 
-    See: https://www.kernel.org/doc/html/latest/process/license-rules.html
+    See: Documentation/process/license-rules.rst
 
   **TYPO_SPELLING**
     Some words may have been misspelled.  Consider reviewing them.
diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
index 46d0b036c97eb5..c90b5e6d8be4ef 100644
--- a/Documentation/devicetree/bindings/submitting-patches.rst
+++ b/Documentation/devicetree/bindings/submitting-patches.rst
@@ -4,6 +4,8 @@
 Submitting Devicetree (DT) binding patches
 ==========================================
 
+.. _submitting-dt-patches:
+
 I. For patch submitters
 =======================
 
diff --git a/Documentation/driver-api/driver-model/device.rst b/Documentation/driver-api/driver-model/device.rst
index 0833be568b06ca..7762d11411c5a9 100644
--- a/Documentation/driver-api/driver-model/device.rst
+++ b/Documentation/driver-api/driver-model/device.rst
@@ -35,6 +35,8 @@ A driver can access the lock in the device structure using::
   void unlock_device(struct device * dev);
 
 
+.. _device-attributes:
+
 Attributes
 ~~~~~~~~~~
 
diff --git a/Documentation/filesystems/sysfs.rst b/Documentation/filesystems/sysfs.rst
index 624e4f51212e63..a893e67f7fb2bb 100644
--- a/Documentation/filesystems/sysfs.rst
+++ b/Documentation/filesystems/sysfs.rst
@@ -51,6 +51,8 @@ With the current sysfs implementation the kobject reference count is
 only modified directly by the function sysfs_schedule_callback().
 
 
+.. _sysfs-attributes:
+
 Attributes
 ~~~~~~~~~~
 
diff --git a/Documentation/kbuild/reproducible-builds.rst b/Documentation/kbuild/reproducible-builds.rst
index f2dcc39044e66d..b0d273f871772a 100644
--- a/Documentation/kbuild/reproducible-builds.rst
+++ b/Documentation/kbuild/reproducible-builds.rst
@@ -13,6 +13,8 @@ The `Reproducible Builds project`_ has more information about this
 general topic.  This document covers the various reasons why building
 the kernel may be unreproducible, and how to avoid them.
 
+.. _kernel-timestamps:
+
 Timestamps
 ----------
 
diff --git a/Documentation/locking/lockdep-design.rst b/Documentation/locking/lockdep-design.rst
index 56b90eea27312e..c924dd4216c564 100644
--- a/Documentation/locking/lockdep-design.rst
+++ b/Documentation/locking/lockdep-design.rst
@@ -231,6 +231,8 @@ Note: When changing code to use the _nested() primitives, be careful and
 check really thoroughly that the hierarchy is correctly mapped; otherwise
 you can get false positives or false negatives.
 
+.. _lockdep-annotations:
+
 Annotations
 -----------
 
diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index d1a8e5465ed956..4a17c60a9240c0 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -15,6 +15,8 @@ and NOT read it.  Burn them, it's a great symbolic gesture.
 Anyway, here goes:
 
 
+.. _indentation-style:
+
 1) Indentation
 --------------
 
@@ -95,6 +97,8 @@ used for indentation, and the above example is deliberately broken.
 Get a decent editor and don't leave whitespace at the end of lines.
 
 
+.. _long-line-break:
+
 2) Breaking long lines and strings
 ----------------------------------
 
@@ -117,6 +121,8 @@ However, never break user-visible strings such as printk messages because
 that breaks the ability to grep for them.
 
 
+.. _braces-placement:
+
 3) Placing Braces and Spaces
 ----------------------------
 
@@ -231,6 +237,8 @@ Also, use braces when a loop contains more than a single simple statement:
 			do_something();
 	}
 
+.. _spaces-usage:
+
 3.1) Spaces
 ***********
 
@@ -303,6 +311,8 @@ of patches, this may make later patches in the series fail by changing their
 context lines.
 
 
+.. _naming-convention:
+
 4) Naming
 ---------
 
@@ -594,6 +604,7 @@ fix for this is to split it up into two error labels ``err_free_bar:`` and
 
 Ideally you should simulate errors to test all exit paths.
 
+.. _comments-style:
 
 8) Commenting
 -------------
@@ -792,6 +803,8 @@ Remember: if another thread can find your data structure, and you don't
 have a reference count on it, you almost certainly have a bug.
 
 
+.. _macros-style:
+
 12) Macros, Enums and RTL
 -------------------------
 
@@ -932,6 +945,8 @@ already inside a debug-related #ifdef section, printk(KERN_DEBUG ...) can be
 used.
 
 
+.. _memory-allocation-style:
+
 14) Allocating memory
 ---------------------
 
diff --git a/Documentation/process/deprecated.rst b/Documentation/process/deprecated.rst
index 1f7f3e6c9cda9f..8ab538034a29b9 100644
--- a/Documentation/process/deprecated.rst
+++ b/Documentation/process/deprecated.rst
@@ -29,6 +29,8 @@ a header file, it isn't the full solution. Such interfaces must either
 be fully removed from the kernel, or added to this file to discourage
 others from using them in the future.
 
+.. _bug-macros-deprecated:
+
 BUG() and BUG_ON()
 ------------------
 Use WARN() and WARN_ON() instead, and handle the "impossible"
@@ -109,6 +111,8 @@ For more details, also see array3_size() and flex_array_size(),
 as well as the related check_mul_overflow(), check_add_overflow(),
 check_sub_overflow(), and check_shl_overflow() family of functions.
 
+.. _simple-strtol-family-deprecated:
+
 simple_strtol(), simple_strtoll(), simple_strtoul(), simple_strtoull()
 ----------------------------------------------------------------------
 The simple_strtol(), simple_strtoll(),
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index cede4e7b29af46..34a6a7c8e6f49e 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -393,6 +393,8 @@ e-mail discussions.
 ``git send-email`` will do this for you automatically.
 
 
+.. _dco-signoff:
+
 Sign your work - the Developer's Certificate of Origin
 ------------------------------------------------------
 
@@ -406,6 +408,8 @@ patch, which certifies that you wrote it or otherwise have the right to
 pass it on as an open-source patch.  The rules are pretty simple: if you
 can certify the below:
 
+.. _dco-text:
+
 Developer's Certificate of Origin 1.1
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- 
An old man doll... just what I always wanted! - Clara


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

* Re: [PATCH 08/14] Documentation: gpu: Use internal link to kunit
  2025-08-29  7:55 ` [PATCH 08/14] Documentation: gpu: " Bagas Sanjaya
@ 2025-08-29 12:00   ` Thomas Zimmermann
  0 siblings, 0 replies; 24+ messages in thread
From: Thomas Zimmermann @ 2025-08-29 12:00 UTC (permalink / raw)
  To: Bagas Sanjaya, 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	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,
	Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
	Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Laurent Pinchart, Steve French,
	Meetakshi Setiya, Greg Kroah-Hartman, Martin K. Petersen,
	Bart Van Assche, Thomas Weißschuh, Masahiro Yamada



Am 29.08.25 um 09:55 schrieb Bagas Sanjaya:
> Use internal linking to kunit documentation.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Acked-by: Thomas Zimmermann <tzimmermann@suse.de>

Fell free to merge it through a tree of your choice.

Best regards
Thomas

> ---
>   Documentation/gpu/todo.rst | 6 +++---
>   1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst
> index be8637da3fe950..efe9393f260ae2 100644
> --- a/Documentation/gpu/todo.rst
> +++ b/Documentation/gpu/todo.rst
> @@ -655,9 +655,9 @@ Better Testing
>   Add unit tests using the Kernel Unit Testing (KUnit) framework
>   --------------------------------------------------------------
>   
> -The `KUnit <https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html>`_
> -provides a common framework for unit tests within the Linux kernel. Having a
> -test suite would allow to identify regressions earlier.
> +The :doc:`KUnit </dev-tools/kunit/index>` provides a common framework for unit
> +tests within the Linux kernel. Having a test suite would allow to identify
> +regressions earlier.
>   
>   A good candidate for the first unit tests are the format-conversion helpers in
>   ``drm_format_helper.c``.

-- 
--
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Frankenstrasse 146, 90461 Nuernberg, Germany
GF: Ivo Totev, Andrew Myers, Andrew McDonald, Boudien Moerman
HRB 36809 (AG Nuernberg)



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

* Re: [PATCH 00/14] Internalize www.kernel.org/doc cross-reference
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (13 preceding siblings ...)
  2025-08-29  7:55 ` [PATCH 14/14] Documentation: checkpatch: Convert kernel docs references Bagas Sanjaya
@ 2025-08-29 12:18 ` Jani Nikula
  2025-08-29 13:18   ` Bagas Sanjaya
  2025-08-29 22:19 ` (subset) " Mark Brown
  15 siblings, 1 reply; 24+ messages in thread
From: Jani Nikula @ 2025-08-29 12:18 UTC (permalink / raw)
  To: Bagas Sanjaya, 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Bagas Sanjaya, Laurent Pinchart,
	Steve French, Meetakshi Setiya, Greg Kroah-Hartman,
	Martin K. Petersen, Bart Van Assche, Thomas Weißschuh,
	Masahiro Yamada

On Fri, 29 Aug 2025, Bagas Sanjaya <bagasdotme@gmail.com> wrote:
> 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. Note that this does not
> cover docs.kernel.org links nor touching Documentation/tools (as
> docs containing external links are in manpages).

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".


BR,
Jani.


-- 
Jani Nikula, Intel

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

* Re: [PATCH 00/14] Internalize www.kernel.org/doc cross-reference
  2025-08-29 12:18 ` [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Jani Nikula
@ 2025-08-29 13:18   ` Bagas Sanjaya
  0 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-29 13:18 UTC (permalink / raw)
  To: Jani Nikula, 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Laurent Pinchart, Steve French,
	Meetakshi Setiya, Greg Kroah-Hartman, Martin K. Petersen,
	Bart Van Assche, Thomas Weißschuh, Masahiro Yamada

[-- 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 --]

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

* Re: [PATCH 02/14] Documentation: damon: reclaim: Convert "Free Page Reporting" citation link
  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
  0 siblings, 0 replies; 24+ messages in thread
From: SeongJae Park @ 2025-08-29 15:36 UTC (permalink / raw)
  To: Bagas Sanjaya
  Cc: SeongJae Park, 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, Borislav Petkov, Peter Zijlstra,
	Josh Poimboeuf, Pawan Gupta, Jonathan Corbet, 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Laurent Pinchart, Steve French,
	Meetakshi Setiya, Greg Kroah-Hartman, Martin K. Petersen,
	Bart Van Assche, Thomas Weißschuh, Masahiro Yamada

On Fri, 29 Aug 2025 14:55:12 +0700 Bagas Sanjaya <bagasdotme@gmail.com> wrote:

> Use internal cross-reference for the citation link to Free Page
> Reporting docs.

Thank you for fixing this!

> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: SeongJae Park <sj@kernel.org>


Thanks,
SJ

[...]

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

* RE: [PATCH 11/14] Documentation: net: Convert external kernel networking docs
  2025-08-29  7:55 ` [PATCH 11/14] Documentation: net: Convert external kernel networking docs Bagas Sanjaya
@ 2025-08-29 16:29   ` Kiyanovski, Arthur
  0 siblings, 0 replies; 24+ messages in thread
From: Kiyanovski, Arthur @ 2025-08-29 16:29 UTC (permalink / raw)
  To: Bagas Sanjaya, 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@mit.edu, Richard Weinberger, Zhihao Cheng,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, Nathan Chancellor, Nicolas Schier, Ingo Molnar,
	Will Deacon, Boqun Feng, Waiman Long, David S. Miller,
	Eric Dumazet, Jakub Kicinski, Paolo Abeni, Simon Horman,
	Allen, Neil, Arinzon, David, Bshara, Saeed, Andrew Lunn,
	Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
	Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Laurent Pinchart, Steve French,
	Meetakshi Setiya, Greg Kroah-Hartman, Martin K. Petersen,
	Bart Van Assche, Thomas Weißschuh, Masahiro Yamada

> -----Original Message-----
> From: Bagas Sanjaya <bagasdotme@gmail.com>
> Sent: Friday, August 29, 2025 12:55 AM
>
> Convert cross-references to kernel networking docs that use external links
> into internal ones.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  .../device_drivers/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 +++++-------
>  4 files changed, 9 insertions(+), 13 deletions(-)
> 
> diff --git
> a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> index 14784a0a6a8a10..b7b314de857b01 100644
> --- a/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> +++ b/Documentation/networking/device_drivers/ethernet/amazon/ena.rst
> @@ -366,9 +366,9 @@ RSS
> 
>  DEVLINK SUPPORT
>  ===============
> -.. _`devlink`:
> https://www.kernel.org/doc/html/latest/networking/devlink/index.html
> 
> -`devlink`_ supports reloading the driver and initiating re-negotiation with the
> ENA device
> +:doc:`devlink </networking/devlink/index>` supports reloading the
> +driver and initiating re-negotiation with the ENA device
> 
>  .. code-block:: shell

Thank you for submitting this patchset.
For the ena driver change:

Reviewed-by: Arthur Kiyanovski <akiyano@amazon.com>

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

* Re: (subset) [PATCH 00/14] Internalize www.kernel.org/doc cross-reference
  2025-08-29  7:55 [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Bagas Sanjaya
                   ` (14 preceding siblings ...)
  2025-08-29 12:18 ` [PATCH 00/14] Internalize www.kernel.org/doc cross-reference Jani Nikula
@ 2025-08-29 22:19 ` Mark Brown
  15 siblings, 0 replies; 24+ messages in thread
From: Mark Brown @ 2025-08-29 22:19 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, Bagas Sanjaya
  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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Jaroslav Kysela, Takashi Iwai,
	Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Laurent Pinchart, Steve French,
	Meetakshi Setiya, Greg Kroah-Hartman, Martin K. Petersen,
	Bart Van Assche, Thomas Weißschuh, Masahiro Yamada

On Fri, 29 Aug 2025 14:55:10 +0700, Bagas Sanjaya wrote:
> 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``).
> 
> [...]

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[12/14] ASoC: doc: Internally link to Writing an ALSA Driver docs
        commit: f522da9ab56c96db8703b2ea0f09be7cdc3bffeb

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark


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

* Re: [PATCH 12/14] ASoC: doc: Internally link to Writing an ALSA Driver docs
  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
  0 siblings, 1 reply; 24+ messages in thread
From: Mauro Carvalho Chehab @ 2025-08-30 20:46 UTC (permalink / raw)
  To: Bagas Sanjaya
  Cc: 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, 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, David Airlie, Simona Vetter,
	Maarten Lankhorst, Maxime Ripard, Thomas Zimmermann,
	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,
	Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
	Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Laurent Pinchart, Steve French,
	Meetakshi Setiya, Greg Kroah-Hartman, Martin K. Petersen,
	Bart Van Assche, Thomas Weißschuh, Masahiro Yamada

Em Fri, 29 Aug 2025 14:55:22 +0700
Bagas Sanjaya <bagasdotme@gmail.com> escreveu:

> ASoC codec and platform driver docs contain reference to writing ALSA
> driver docs, as an external link. Use :doc: directive for the job
> instead.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/sound/soc/codec.rst    | 4 ++--
>  Documentation/sound/soc/platform.rst | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/sound/soc/codec.rst b/Documentation/sound/soc/codec.rst
> index af973c4cac9309..b9d87a4f929b5d 100644
> --- a/Documentation/sound/soc/codec.rst
> +++ b/Documentation/sound/soc/codec.rst
> @@ -131,8 +131,8 @@ The codec driver also supports the following ALSA PCM operations:-
>  	int (*prepare)(struct snd_pcm_substream *);
>    };
>  
> -Please refer to the ALSA driver PCM documentation for details.
> -https://www.kernel.org/doc/html/latest/sound/kernel-api/writing-an-alsa-driver.html
> +Please refer to the :doc:`ALSA driver PCM documentation
> +<../kernel-api/writing-an-alsa-driver>` for details.
>  
>  
>  DAPM description
> diff --git a/Documentation/sound/soc/platform.rst b/Documentation/sound/soc/platform.rst
> index 7036630eaf016c..bd21d0a4dd9b0b 100644
> --- a/Documentation/sound/soc/platform.rst
> +++ b/Documentation/sound/soc/platform.rst
> @@ -45,8 +45,8 @@ snd_soc_component_driver:-
>  	...
>    };
>  
> -Please refer to the ALSA driver documentation for details of audio DMA.
> -https://www.kernel.org/doc/html/latest/sound/kernel-api/writing-an-alsa-driver.html
> +Please refer to the :doc:`ALSA driver documentation
> +<../kernel-api/writing-an-alsa-driver>` for details of audio DMA.

Don't use relative paths for :doc:. They don't work well, specially
when one uses SPHINXDIRS.

The best is o use Documentation/kernel-api/writing-an-alsa-driver.rst
and let automarkup figure it out. As we have a checker, broken
references generate warnings at build time.

Regards,
Mauro

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

* Re: [PATCH 12/14] ASoC: doc: Internally link to Writing an ALSA Driver docs
  2025-08-30 20:46   ` Mauro Carvalho Chehab
@ 2025-08-30 23:11     ` Bagas Sanjaya
  0 siblings, 0 replies; 24+ messages in thread
From: Bagas Sanjaya @ 2025-08-30 23:11 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: 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, 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, David Airlie, Simona Vetter,
	Maarten Lankhorst, Maxime Ripard, Thomas Zimmermann,
	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,
	Liam Girdwood, Mark Brown, Jaroslav Kysela, Takashi Iwai,
	Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Laurent Pinchart, Steve French,
	Meetakshi Setiya, Greg Kroah-Hartman, Martin K. Petersen,
	Bart Van Assche, Thomas Weißschuh, Masahiro Yamada

[-- Attachment #1: Type: text/plain, Size: 837 bytes --]

On Sat, Aug 30, 2025 at 10:46:22PM +0200, Mauro Carvalho Chehab wrote:
> Em Fri, 29 Aug 2025 14:55:22 +0700
> Bagas Sanjaya <bagasdotme@gmail.com> escreveu:
> > -Please refer to the ALSA driver documentation for details of audio DMA.
> > -https://www.kernel.org/doc/html/latest/sound/kernel-api/writing-an-alsa-driver.html
> > +Please refer to the :doc:`ALSA driver documentation
> > +<../kernel-api/writing-an-alsa-driver>` for details of audio DMA.
> 
> Don't use relative paths for :doc:. They don't work well, specially
> when one uses SPHINXDIRS.
> 
> The best is o use Documentation/kernel-api/writing-an-alsa-driver.rst
> and let automarkup figure it out. As we have a checker, broken
> references generate warnings at build time.

Thanks for the tip!

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

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

* Re: [PATCH 04/14] Documentation: amd-pstate: Use internal link to kselftest
  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
  0 siblings, 0 replies; 24+ messages in thread
From: Mario Limonciello @ 2025-09-03  3:32 UTC (permalink / raw)
  To: Bagas Sanjaya, 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, 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,
	David Airlie, Simona Vetter, Maarten Lankhorst, Maxime Ripard,
	Thomas Zimmermann, 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, Liam Girdwood, Mark Brown, Jaroslav Kysela,
	Takashi Iwai, Alexandru Ciobotaru, The AWS Nitro Enclaves Team,
	Jesper Dangaard Brouer, Laurent Pinchart, Steve French,
	Meetakshi Setiya, Greg Kroah-Hartman, Martin K. Petersen,
	Bart Van Assche, Thomas Weißschuh, Masahiro Yamada

On 8/29/2025 2:55 AM, Bagas Sanjaya wrote:
> Convert kselftest docs link to internal cross-reference.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>   Documentation/admin-guide/pm/amd-pstate.rst | 3 +--
>   1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
> index e1771f2225d5f0..37082f2493a7c1 100644
> --- a/Documentation/admin-guide/pm/amd-pstate.rst
> +++ b/Documentation/admin-guide/pm/amd-pstate.rst
> @@ -798,5 +798,4 @@ Reference
>   .. [3] Processor Programming Reference (PPR) for AMD Family 19h Model 51h, Revision A1 Processors
>          https://www.amd.com/system/files/TechDocs/56569-A1-PUB.zip
>   
> -.. [4] Linux Kernel Selftests,
> -       https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
> +.. [4] Documentation/dev-tools/kselftest.rst

Acked-by: Mario Limonciello (AMD) <superm1@kernel.org>


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

end of thread, other threads:[~2025-09-03  3:32 UTC | newest]

Thread overview: 24+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
2025-08-29 22:19 ` (subset) " Mark Brown

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).