netdev - Re: [PATCH bpf-next] bpf: fix documentation for eBPF helpers

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: <6064b03f-18b3-558d-73d4-ec88dcc9a0dc@iogearbox.net>
Date:   Mon, 3 Dec 2018 21:46:03 +0100
From:   Daniel Borkmann <daniel@...earbox.net>
To:     Quentin Monnet <quentin.monnet@...ronome.com>,
        Alexei Starovoitov <ast@...nel.org>
Cc:     netdev@...r.kernel.org, oss-drivers@...ronome.com
Subject: Re: [PATCH bpf-next] bpf: fix documentation for eBPF helpers

On 12/03/2018 01:13 PM, Quentin Monnet wrote:
> The missing indentation on the "Return" sections for bpf_map_pop_elem()
> and bpf_map_peek_elem() helpers break RST and man pages generation. This
> patch fixes them, and moves the description of those two helpers towards
> the end of the list (even though they are somehow related to the three
> first helpers for maps, the man page explicitly states that the helpers
> are sorted in chronological order).
> 
> While at it, bring other minor formatting edits for eBPF helpers
> documentation: mostly blank lines removal, RST formatting, or other
> small nits for consistency.
> 
> Signed-off-by: Quentin Monnet <quentin.monnet@...ronome.com>
> Reviewed-by: Jakub Kicinski <jakub.kicinski@...ronome.com>

Applied to bpf-next, thanks!