OSDN Git Service

bpf: clean up eBPF helpers documentation
authorQuentin Monnet <quentin.monnet@netronome.com>
Tue, 29 May 2018 11:27:44 +0000 (12:27 +0100)
committerDaniel Borkmann <daniel@iogearbox.net>
Tue, 29 May 2018 19:42:13 +0000 (21:42 +0200)
commit7a279e93330bd4f0074973293f1cd1aacf7c5fa6
tree028388c902a8a63b4231eba7e63fd7d2784cf42d
parentf198222f056745b2622c89190a13c5a485011014
bpf: clean up eBPF helpers documentation

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@netronome.com>
Acked-by: Song Liu <songliubraving@fb.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
include/uapi/linux/bpf.h
tools/include/uapi/linux/bpf.h