netdev - Re: [PATCH 2/2] bpf, doc: split general purpose eBPF documentation out of filter.rst

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:   Wed, 17 Nov 2021 16:56:13 -0800
From:   Alexei Starovoitov <alexei.starovoitov@...il.com>
To:     Christoph Hellwig <hch@....de>
Cc:     Jonathan Corbet <corbet@....net>,
        "David S. Miller" <davem@...emloft.net>,
        Jakub Kicinski <kuba@...nel.org>,
        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
Subject: Re: [PATCH 2/2] bpf, doc: split general purpose eBPF documentation
 out of filter.rst

On Mon, Nov 15, 2021 at 02:07:15PM +0100, Christoph Hellwig wrote:
> filter.rst starts out documenting the classic BPF and then spills into
> introducing and documentating eBPF.  Split the eBPF documentation into
> three new files under Documentation/bpf/ and link to that.
> 
> Signed-off-by: Christoph Hellwig <hch@....de>
> ---
>  Documentation/bpf/index.rst           |   30 +-
>  Documentation/bpf/instruction-set.rst |  491 ++++++++++++
>  Documentation/bpf/maps.rst            |   43 +
>  Documentation/bpf/verifier.rst        |  533 +++++++++++++
>  Documentation/networking/filter.rst   | 1059 +------------------------
...
> +.. Links:
> +.. _eBPF: ../bpf/instrution-set.rst

I think the split would be good in the long term, but please make the links
more obvious somehow in the filter.rst, since a bunch of posts on the web
link back to that file. The folks who will be reading the revamped filter.rst
would need a very obvious way to navigate to new pages.

In terms of followups and cleanup... please share what you have in mind.