Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

libbpf: Complete the missing @param and @return tags in btf.h

Complete the missing @param and @return tags in the Doxygen comments of
the btf.h file.

Signed-off-by: Jianyun Gao <jianyungao89@gmail.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20251103115836.144339-1-jianyungao89@gmail.com

authored by

Jianyun Gao and committed by
Andrii Nakryiko
74bd7bc0 11369e6e

+8
+8
tools/lib/bpf/btf.h
··· 94 94 * @brief **btf__new_empty_split()** creates an unpopulated BTF object from an 95 95 * ELF BTF section except with a base BTF on top of which split BTF should be 96 96 * based 97 + * @param base_btf base BTF object 97 98 * @return new BTF object instance which has to be eventually freed with 98 99 * **btf__free()** 99 100 * ··· 116 115 * When that split BTF is loaded against a (possibly changed) base, this 117 116 * distilled base BTF will help update references to that (possibly changed) 118 117 * base BTF. 118 + * @param src_btf source split BTF object 119 + * @param new_base_btf pointer to where the new base BTF object pointer will be stored 120 + * @param new_split_btf pointer to where the new split BTF object pointer will be stored 121 + * @return 0 on success; negative error code, otherwise 119 122 * 120 123 * Both the new split and its associated new base BTF must be freed by 121 124 * the caller. ··· 269 264 * to base BTF kinds, and verify those references are compatible with 270 265 * *base_btf*; if they are, *btf* is adjusted such that is re-parented to 271 266 * *base_btf* and type ids and strings are adjusted to accommodate this. 267 + * @param btf split BTF object to relocate 268 + * @param base_btf base BTF object 269 + * @return 0 on success; negative error code, otherwise 272 270 * 273 271 * If successful, 0 is returned and **btf** now has **base_btf** as its 274 272 * base.