Thread (3 messages) 3 messages, 3 authors, 2021-04-22
STALE1880d

[PATCH bpf-next v4] bpf: Fix some invalid links in bpf_devel_QA.rst

From: Tiezhu Yang <yangtiezhu@loongson.cn>
Date: 2021-04-22 11:10:16
Also in: bpf, linux-doc, lkml
Subsystem: bpf [general] (safe dynamic programs and tools), documentation, the rest · Maintainers: Alexei Starovoitov, Daniel Borkmann, Andrii Nakryiko, Eduard Zingerman, Kumar Kartikeya Dwivedi, Jonathan Corbet, Linus Torvalds

There exist some errors "404 Not Found" when I click the link
of "MAINTAINERS" [1], "samples/bpf/" [2] and "selftests" [3]
in the documentation "HOWTO interact with BPF subsystem" [4].

As Jesper Dangaard Brouer said, the links work if you are browsing
the document via GitHub [5], so I think maybe it is better to use
the corresponding GitHub links to fix the issues in the kernel.org
official document [4], this change has no influence on GitHub and
looks like more clear.

[1] https://www.kernel.org/doc/html/MAINTAINERS
[2] https://www.kernel.org/doc/html/samples/bpf/
[3] https://www.kernel.org/doc/html/tools/testing/selftests/bpf/
[4] https://www.kernel.org/doc/html/latest/bpf/bpf_devel_QA.html
[5] https://github.com/torvalds/linux/blob/master/Documentation/bpf/bpf_devel_QA.rst

Fixes: 542228384888 ("bpf, doc: convert bpf_devel_QA.rst to use RST formatting")
Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn>
---

The initial aim is to fix the invalid links, sorry for the noisy.

v4: Use the corresponding GitHub links

v3: Remove "MAINTAINERS" and "samples/bpf/" links and
    use correct link of "selftests"

v2: Add Fixes: tag

 Documentation/bpf/bpf_devel_QA.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/bpf/bpf_devel_QA.rst b/Documentation/bpf/bpf_devel_QA.rst
index 2ed89ab..36a9b62 100644
--- a/Documentation/bpf/bpf_devel_QA.rst
+++ b/Documentation/bpf/bpf_devel_QA.rst
@@ -645,10 +645,10 @@ when:
 
 .. Links
 .. _Documentation/process/: https://www.kernel.org/doc/html/latest/process/
-.. _MAINTAINERS: ../../MAINTAINERS
+.. _MAINTAINERS: https://github.com/torvalds/linux/blob/master/MAINTAINERS
 .. _netdev-FAQ: ../networking/netdev-FAQ.rst
-.. _samples/bpf/: ../../samples/bpf/
-.. _selftests: ../../tools/testing/selftests/bpf/
+.. _samples/bpf/: https://github.com/torvalds/linux/tree/master/samples/bpf
+.. _selftests: https://github.com/torvalds/linux/tree/master/tools/testing/selftests/bpf
 .. _Documentation/dev-tools/kselftest.rst:
    https://www.kernel.org/doc/html/latest/dev-tools/kselftest.html
 .. _Documentation/bpf/btf.rst: btf.rst
-- 
2.1.0
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help