OSDN Git Service

uapi/bpf: Add missing description and returns for helper documentation
authorUsama Arif <usama.arif@bytedance.com>
Wed, 19 Jan 2022 11:44:40 +0000 (11:44 +0000)
committerAndrii Nakryiko <andrii@kernel.org>
Wed, 19 Jan 2022 18:24:50 +0000 (10:24 -0800)
commite40fbbf0572c5e41dc87ad79001748ed399ce32d
tree4acb95f858f33163304d48d86d5e0a2e830167d1
parentb662000aff84f2ca9660db15e5f8ac926681df27
uapi/bpf: Add missing description and returns for helper documentation

Both description and returns section will become mandatory
for helpers and syscalls in a later commit to generate man pages.

This commit also adds in the documentation that BPF_PROG_RUN is
an alias for BPF_PROG_TEST_RUN for anyone searching for the
syscall in the generated man pages.

Signed-off-by: Usama Arif <usama.arif@bytedance.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20220119114442.1452088-1-usama.arif@bytedance.com
include/uapi/linux/bpf.h
tools/include/uapi/linux/bpf.h