netdev - Re: [PATCH bpf-next] bpf: clean up eBPF helpers documentation

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: <CAH3iqT7T=iCSui7Qm+mr1vX93tmJD5_ftHsFjX5QGHwa6ohaDQ@mail.gmail.com>
Date:   Wed, 30 May 2018 08:28:42 +0100
From:   Quentin Monnet <quentin.monnet@...ronome.com>
To:     Daniel Borkmann <daniel@...earbox.net>
Cc:     Song Liu <liu.song.a23@...il.com>,
        Alexei Starovoitov <ast@...nel.org>,
        Networking <netdev@...r.kernel.org>, oss-drivers@...ronome.com
Subject: Re: [PATCH bpf-next] bpf: clean up eBPF helpers documentation

On 29 May 2018 at 20:44, Daniel Borkmann <daniel@...earbox.net> wrote:
> On 05/29/2018 08:27 PM, Song Liu wrote:
>> On Tue, May 29, 2018 at 4:27 AM, Quentin Monnet
>> <quentin.monnet@...ronome.com> wrote:
>>> These are minor edits for the eBPF helpers documentation in
>>> include/uapi/linux/bpf.h.
>>>
>>> The main fix consists in removing "BPF_FIB_LOOKUP_", because it ends
>>> with a non-escaped underscore that gets interpreted by rst2man and
>>> produces the following message in the resulting manual page:
>>>
>>>     DOCUTILS SYSTEM MESSAGES
>>>            System Message: ERROR/3 (/tmp/bpf-helpers.rst:, line 1514)
>>>                   Unknown target name: "bpf_fib_lookup".
>>>
>>> Other edits consist in:
>>>
>>> - Improving formatting for flag values for "bpf_fib_lookup()" helper.
>>> - Emphasising a parameter name in description of the return value for
>>>   "bpf_get_stack()" helper.
>>> - Removing unnecessary blank lines between "Description" and "Return"
>>>   sections for the few helpers that would use it, for consistency.
>>>
>>> Signed-off-by: Quentin Monnet <quentin.monnet@...ronome.com>
> [...]
>>
>> Please also apply the same changes to tools/include/uapi/linux/bpf.h.

Ah, true, I forgot it... Thanks for the reminder.

> Just did while applying to bpf-next, thanks guys!
>
>> Other than this, it looks to me.
>>
>> Acked-by: Song Liu <songliubraving@...com>

Thanks a lot Song, Daniel!
Quentin