bpf: fix documentation for eBPF helpers
authorQuentin Monnet <quentin.monnet@netronome.com>
Thu, 14 Mar 2019 12:38:39 +0000 (12:38 +0000)
committerAlexei Starovoitov <ast@kernel.org>
Thu, 14 Mar 2019 21:03:21 +0000 (14:03 -0700)
commit62369db2df8d1edfa040878203b446e023a16802
tree2d35759b69b786fb7de6d41e14bc320a3595d88a
parentcd70182e8d530bf806176c529105c350d4d7fbd9
bpf: fix documentation for eBPF helpers

Another round of minor fixes for the documentation of the BPF helpers
located in the UAPI bpf.h header file. Changes include:

- Moving around description of some helpers, to keep the descriptions in
  the same order as helpers are declared (bpf_map_push_elem(), leftover
  from commit 90b1023f68c7 ("bpf: fix documentation for eBPF helpers"),
  bpf_rc_keydown(), and bpf_skb_ancestor_cgroup_id()).
- Fixing typos ("contex" -> "context").
- Harmonising return types ("void* " -> "void *", "uint64_t" -> "u64").
- Addition of the "bpf_" prefix to bpf_get_storage().
- Light additions of RST markup on some keywords.
- Empty line deletion between description and return value for
  bpf_tcp_sock().
- Edit for the description for bpf_skb_ecn_set_ce() (capital letters,
  acronym expansion, no effect if ECT not set, more details on return
  value).

Signed-off-by: Quentin Monnet <quentin.monnet@netronome.com>
Reviewed-by: Jakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
include/uapi/linux/bpf.h