linux-kernel - Re: [PATCH bpf-next v4] bpf: Fix some invalid links in bpf_devel

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Thu, 22 Apr 2021 09:46:33 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Tiezhu Yang <yangtiezhu@...ngson.cn>,
        Alexei Starovoitov <ast@...nel.org>,
        Daniel Borkmann <daniel@...earbox.net>,
        Andrii Nakryiko <andrii@...nel.org>,
        Martin KaFai Lau <kafai@...com>,
        Song Liu <songliubraving@...com>, Yonghong Song <yhs@...com>,
        John Fastabend <john.fastabend@...il.com>,
        KP Singh <kpsingh@...nel.org>
Cc:     Jesper Dangaard Brouer <brouer@...hat.com>,
        linux-doc@...r.kernel.org, netdev@...r.kernel.org,
        bpf@...r.kernel.org, linux-kernel@...r.kernel.org,
        Xuefeng Li <lixuefeng@...ngson.cn>
Subject: Re: [PATCH bpf-next v4] bpf: Fix some invalid links in
 bpf_devel_QA.rst

Tiezhu Yang <yangtiezhu@...ngson.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@...ngson.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