]> git.baikalelectronics.ru Git - kernel.git/commit
projects / kernel.git / commit
? search:
summary | shortlog | log | commit | commitdiff | tree
(parent: 2220ecf) | patch
libbpf: Add sphinx code documentation comments
authorGrant Seltzer <grantseltzer@gmail.com>
Wed, 15 Sep 2021 02:19:52 +0000 (22:19 -0400)
committerAndrii Nakryiko <andrii@kernel.org>
Wed, 15 Sep 2021 20:16:02 +0000 (13:16 -0700)
commit69cd823956ba8ce266a901170b1060db8073bddd
tree9a46ab82d2648d0c51a7efec2985b0d710bc1d8ftree | snapshot
parent2220ecf55c1b7aa36e99b00a6b964f4e5333f9bfcommit | diff
libbpf: Add sphinx code documentation comments

This adds comments above five functions in btf.h which document
their uses. These comments are of a format that doxygen and sphinx
can pick up and render. These are rendered by libbpf.readthedocs.org

Signed-off-by: Grant Seltzer <grantseltzer@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20210915021951.117186-1-grantseltzer@gmail.com
tools/lib/bpf/btf.h diff | blob | history
Linux Kernel Source Tree.