iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
linux/Documentation/bpf
History
Grant Seltzer 9330303446 libbpf: Add API documentation convention guidelines 
This adds a section to the documentation for libbpf
naming convention which describes how to document
API features in libbpf, specifically the format of
which API doc comments need to conform to.

Signed-off-by: Grant Seltzer <grantseltzer@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Acked-by: Song Liu <songliubraving@fb.com>
Link: https://lore.kernel.org/bpf/20211004215644.497327-1-grantseltzer@gmail.com
2021-10-06 12:34:02 -07:00
..
libbpf
libbpf: Add API documentation convention guidelines
2021-10-06 12:34:02 -07:00
bpf_design_QA.rst
bpf: Update bpf_design_QA.rst to clarify the kfunc call is not ABI
2021-03-30 07:31:01 -07:00
bpf_devel_QA.rst
bpf: Document the pahole release info related to libbpf in bpf_devel_QA.rst
2021-04-23 17:11:58 -07:00
bpf_licensing.rst
bpf: Document BPF licensing.
2021-09-22 23:13:13 +02:00
bpf_lsm.rst
docs: bpf: bpf_lsm.rst: avoid using ReST :doc:foo markup
2021-06-17 13:24:37 -06:00
btf.rst
docs/bpf: Add documentation for BTF_KIND_TAG
2021-09-14 18:45:53 -07:00
drgn.rst
bpf: Document bpf_inspect drgn tool
2020-03-26 00:08:36 +01:00
index.rst
bpf: Document BPF licensing.
2021-09-22 23:13:13 +02:00
llvm_reloc.rst
bpf, docs: Add llvm_reloc.rst to explain llvm bpf relocations
2021-05-28 22:12:04 +02:00
map_cgroup_storage.rst
Documentation/bpf: Document CGROUP_STORAGE map type
2020-07-25 20:16:36 -07:00
prog_cgroup_sockopt.rst
bpf: Document optval > PAGE_SIZE behavior for sockopt hooks
2020-06-17 10:54:05 -07:00
prog_cgroup_sysctl.rst
bpf: Document BPF_PROG_TYPE_CGROUP_SYSCTL
2019-04-18 16:05:36 -07:00
prog_flow_dissector.rst
bpf/flow_dissector: add mode to enforce global BPF flow dissector
2019-10-07 20:16:33 -07:00
prog_sk_lookup.rst
bpf: sk_lookup: Add user documentation
2020-08-24 14:46:50 -07:00
ringbuf.rst
docs/bpf: Remove source code links
2020-09-14 18:46:54 -07:00
s390.rst
bpf: Add s390 testing documentation
2019-10-30 16:25:31 +01:00