]> git.baikalelectronics.ru Git - kernel.git/commit
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)
commitfb8e2eee2cd89ed48c05880e677e94c9ad1c0121
tree0de55d8305e8deec983dea03136bd6ec41f2a44a
parent2313756853d7b15e4f0bd5b37d765744bcd4d464
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