OSDN Git Service

bpf: fix documentation for eBPF helpers
authorQuentin Monnet <quentin.monnet@netronome.com>
Mon, 3 Dec 2018 12:13:35 +0000 (12:13 +0000)
committerDaniel Borkmann <daniel@iogearbox.net>
Mon, 3 Dec 2018 20:38:17 +0000 (21:38 +0100)
commit90b1023f68c78b9b85e364250155776c8e421176
tree0de55d8305e8deec983dea03136bd6ec41f2a44a
parente3da08d057002f9d0831949d51666c3e15dc6b29
bpf: fix documentation for eBPF helpers

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@netronome.com>
Reviewed-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
include/uapi/linux/bpf.h