bpf: Document BPF_PROG_TYPE_CGROUP_SYSCTL
authorAndrey Ignatov <rdna@fb.com>
Thu, 18 Apr 2019 05:28:57 +0000 (22:28 -0700)
committerAlexei Starovoitov <ast@kernel.org>
Thu, 18 Apr 2019 23:05:36 +0000 (16:05 -0700)
commitda70314917862d4da4a8d7601cd47339df8b3c23
tree0cac8ecc4fb871f8f22a24dbf9727ec41ebb9c7a
parentba02de1aa04e392e15ef503c6dd5166915d9d4de
bpf: Document BPF_PROG_TYPE_CGROUP_SYSCTL

Add documentation for BPF_PROG_TYPE_CGROUP_SYSCTL, including general
info, attach type, context, return code, helpers, example and usage
considerations.

A separate file prog_cgroup_sysctl.rst is added to Documentation/bpf/.

In the future more program types can be documented in their own
prog_<name>.rst files.

Another way to place program type specific documentation would be to
group program types somehow (e.g. cgroup.rst for all cgroup-bpf
programs), but it may not scale well since some program types may belong
to different groups, e.g. BPF_PROG_TYPE_CGROUP_SKB can be documented
together with either cgroup-bpf programs or programs that access skb.

The new file is added to the index and verified by `make htmldocs` /
sanity-check by lynx.

Signed-off-by: Andrey Ignatov <rdna@fb.com>
Acked-by: Yonghong Song <yhs@fb.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Documentation/bpf/index.rst
Documentation/bpf/prog_cgroup_sysctl.rst [new file with mode: 0644]