netdev - Re: [PATCH v2 0/4] docs: bpf: Fix RST conversion

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: <4313ac87-420f-529f-4edb-0efa60c28e0b@iogearbox.net>
Date:   Fri, 27 Jul 2018 07:25:59 +0200
From:   Daniel Borkmann <daniel@...earbox.net>
To:     "Tobin C. Harding" <me@...in.cc>,
        "David S. Miller" <davem@...emloft.net>
Cc:     Jonathan Corbet <corbet@....net>,
        Sergei Shtylyov <sergei.shtylyov@...entembedded.com>,
        Alexei Starovoitov <ast@...nel.org>, linux-doc@...r.kernel.org,
        netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 0/4] docs: bpf: Fix RST conversion

On 07/26/2018 07:03 AM, Tobin C. Harding wrote:
> Hi Dave,
> 
> I'm sending v2 of this to you instead of to Jon.  Rationale: BPF is to
> do with networking anyways and there is a broken link that requires
> conversion of Documentation/networking/filter.txt to fix and that will
> go to you.  FTR there are no merge conflicts between this set and the
> other set I just sent (either can be applied on top of the other)
> 
>    [PATCH v2 net-next 0/3] docs: net: Convert netdev-FAQ to RST
> 
> 
> Recently BPF docs were converted to RST format.  A couple of things were
> missed.
> 
>  - Use 'index.rst' instead of 'README.rst'.  Although README.rst will
>    work just fine it is more typical to keep the subdirectory indices
>    in a file called 'index.rst'.
> 
>  - Integrate files Documentation/bpf/*.rst into build system using
>    toctree in Documentation/bpf/index.rst
> 
>  - Include bpf/index in top level toctree so bpf is indexed in the main
>    kernel docs.
> 
>  - Make anal change to heading format (inline with rest of Documentation/).
> 
> 
> thanks,
> Tobin.

Applied to bpf-next, thanks Tobin!