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

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

[Tiezhu Yang]

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

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

[Jonathan Corbet]

Tiezhu Yang <yangtiezhu@loongson.cn> writes:

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

No, we really don't want to link to GitHub, that's what we have
kernel.org for.

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

https://www.kernel.org/doc/html/latest/process/maintainers.html

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

https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/samples/bpf

...etc.

Thanks,

jon

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

[Jesper Dangaard Brouer]

On Thu, 22 Apr 2021 09:46:33 -0600
Jonathan Corbet <corbet@lwn.net> wrote:

> Tiezhu Yang <yangtiezhu@loongson.cn> writes:
> 
> > 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.  
> 
> No, we really don't want to link to GitHub, that's what we have
> kernel.org for.

I fully agree.
I actually liked V3 better.

Back when I wrote the documentation with these links, the BPF doc was
not well integrated with the kernels doc-system.  It is today, so it
makes sense to remove the links (that happens to work on GitHub) as you
did in V3.

Today BPF documentation is nicely organized via this link:
 https://www.kernel.org/doc/html/latest/bpf/index.html

-- 
Best regards,
  Jesper Dangaard Brouer
  MSc.CS, Principal Kernel Engineer at Red Hat
  LinkedIn: http://www.linkedin.com/in/brouer