bpf: Document BPF_PROG_TYPE_CGROUP_SYSCTL
Subsystems (4)
PATCH 1/1 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.
--- Documentation/bpf/index.rst | 9 ++ Documentation/bpf/prog_cgroup_sysctl.rst | 125 +++++++++++++++++++++++ 2 files changed, 134 insertions(+) create mode 100644 Documentation/bpf/prog_cgroup_sysctl.rst
Documentation/bpf/index.rst +9 -0
@@ -36,6 +36,15 @@ Two sets of Questions and Answers (Q&A) are maintained. bpf_devel_QA +Program types +============= + +.. toctree:: + :maxdepth: 1 + + prog_cgroup_sysctl + + .. Links: .. _Documentation/networking/filter.txt: ../networking/filter.txt .. _man-pages: https://www.kernel.org/doc/man-pages/
Documentation/bpf/prog_cgroup_sysctl.rst new file +125 -0
125 lines not on this page · raw message
Signature · 1 line
2.17.1
Quoted 15 lines · Andrey Ignatov
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.rstis added toDocumentation/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.rstfor 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_SKBcan be documented together with either cgroup-bpf programs or programs that access skb.
Quoted 4 lines
The new file is added to the index and verified by
make htmldocs/ sanity-check by lynx.Signed-off-by Andrey Ignatov <[email protected]>
Alexei Starovoitov
AppliedQuoted 16 lines · Andrey Ignatov
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.rstis added toDocumentation/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.rstfor 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_SKBcan be documented together with either cgroup-bpf programs or programs that access skb.
Quoted 4 lines
The new file is added to the index and verified by
make htmldocs/ sanity-check by lynx.Signed-off-by Andrey Ignatov <[email protected]>
Applied. Thanks