[PATCH 0/2] Hyperlink fixes for BPF QA documentation

[PATCH 0/2] Hyperlink fixes for BPF QA documentation

[Bagas Sanjaya]

When the broken link fix for Documentation/bpf/bpf_devel_QA.rst was
applied, Daniel Borkmann asked me to also fix some other links in the
documentation [1]. So here is the series.

The fixes in the shortlog below should be self-explanatory.

[1]: https://lore.kernel.org/linux-doc/7cd545a2-4a5c-1961-1cf7-cd0f24e41df8@iogearbox.net/

Bagas Sanjaya (2):
  Documentation: bpf: Do not link to docs.kernel.org for kselftest link
  Documentation: bpf: Link to submitting-patches.rst for general patch
    submission info

 Documentation/bpf/bpf_devel_QA.rst | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)


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

[PATCH 1/2] Documentation: bpf: Do not link to docs.kernel.org for kselftest link

[Bagas Sanjaya]

The question on how to run BPF selftests have a reference link to kernel
selftest documentation (Documentation/dev-tools/kselftest.rst). However,
it uses external link to the documentation at kernel.org/docs (aka
docs.kernel.org) instead, which requires Internet access.

Replace the link with internal linking, by using :doc: directive
while keeping the anchor text.

Fixes: b7a27c3aafa252 ("bpf, doc: howto use/run the BPF selftests")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/bpf/bpf_devel_QA.rst | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
index 715f7321020f27..eb087c599ffa44 100644
--- a/Documentation/bpf/bpf_devel_QA.rst
+++ b/Documentation/bpf/bpf_devel_QA.rst
@@ -461,8 +461,8 @@ needed::
 
   $ sudo make run_tests
 
-See the kernels selftest `Documentation/dev-tools/kselftest.rst`_
-document for further documentation.
+See :doc:`kernel selftest documentation </dev-tools/kselftest>`
+for details.
 
 To maximize the number of tests passing, the .config of the kernel
 under test should match the config file fragment in
@@ -688,7 +688,5 @@ when:
 .. _netdev-FAQ: Documentation/process/maintainer-netdev.rst
 .. _selftests:
    https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
-.. _Documentation/dev-tools/kselftest.rst:
-   https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
 
 Happy BPF hacking!
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 2/2] Documentation: bpf: Link to submitting-patches.rst for general patch submission info

[Bagas Sanjaya]

The link for patch submission information in general refers to index
page for "Working with the kernel development community" section of
kernel docs, whereas the link should have been
Documentation/process/submitting-patches.rst instead.

Replace the index target with appropriate doc.

Fixes: 542228384888f5 ("bpf, doc: convert bpf_devel_QA.rst to use RST formatting")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/bpf/bpf_devel_QA.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
index eb087c599ffa44..b421d94dc9f216 100644
--- a/Documentation/bpf/bpf_devel_QA.rst
+++ b/Documentation/bpf/bpf_devel_QA.rst
@@ -7,8 +7,8 @@ workflows related to reporting bugs, submitting patches, and queueing
 patches for stable kernels.
 
 For general information about submitting patches, please refer to
-`Documentation/process/`_. This document only describes additional specifics
-related to BPF.
+Documentation/process/submitting-patches.rst. This document only describes
+additional specifics related to BPF.
 
 .. contents::
     :local:
@@ -684,7 +684,6 @@ when:
 
 
 .. Links
-.. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/
 .. _netdev-FAQ: Documentation/process/maintainer-netdev.rst
 .. _selftests:
    https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/testing/selftests/bpf/
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/2] Hyperlink fixes for BPF QA documentation

[Daniel Borkmann]

On 2/28/23 8:45 AM, Bagas Sanjaya wrote:
> When the broken link fix for Documentation/bpf/bpf_devel_QA.rst was
> applied, Daniel Borkmann asked me to also fix some other links in the
> documentation [1]. So here is the series.
> 
> The fixes in the shortlog below should be self-explanatory.
> 
> [1]: https://lore.kernel.org/linux-doc/7cd545a2-4a5c-1961-1cf7-cd0f24e41df8@iogearbox.net/
> 
> Bagas Sanjaya (2):
>    Documentation: bpf: Do not link to docs.kernel.org for kselftest link
>    Documentation: bpf: Link to submitting-patches.rst for general patch
>      submission info

The series got applied to bpf, thanks!