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] [day] [month] [year] [list]

Message-ID: <20210422190750.7273292c@carbon>
Date:   Thu, 22 Apr 2021 19:07:50 +0200
From:   Jesper Dangaard Brouer <brouer@...hat.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     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>, linux-doc@...r.kernel.org,
        netdev@...r.kernel.org, bpf@...r.kernel.org,
        linux-kernel@...r.kernel.org, Xuefeng Li <lixuefeng@...ngson.cn>,
        brouer@...hat.com
Subject: Re: [PATCH bpf-next v4] bpf: Fix some invalid links in
 bpf_devel_QA.rst

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

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

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