Re: [PATCH] libbpf: fix some incorrect @param descriptions in the comment of libbpf.h
From: Andrii Nakryiko
Date: Tue Nov 25 2025 - 19:14:14 EST
On Mon, Nov 17, 2025 at 7:30 PM Jianyun Gao <jianyungao89@xxxxxxxxx> wrote:
>
> There are some incorrect @param descriptions in the comment of libbpf.h
> file. The following is a case:
>
> /**
> * @brief **bpf_link__unpin()** unpins the BPF link from a file
> * in the BPFFS specified by a path. This decrements the links
> * reference count.
> *
> * The file pinning the BPF link can also be unlinked by a different
> * process in which case this function will return an error.
> *
> * @param prog BPF program to unpin
> * @param path file path to the pin in a BPF file system
> * @return 0, on success; negative error code, otherwise
> */
> LIBBPF_API int bpf_link__unpin(struct bpf_link *link);
>
> In the parameters of the bpf_link__unpin() function, there are no 'prog'
> and 'path' parameters.
>
> This patch fixes this kind of issues present in the comments of the
> libbpf.h file.
>
> Signed-off-by: Jianyun Gao <jianyungao89@xxxxxxxxx>
> ---
> tools/lib/bpf/libbpf.h | 25 +++++++++++++++----------
> 1 file changed, 15 insertions(+), 10 deletions(-)
>
applied to bpf-next with some minor adjustments (which is why
patchworks bot didn't send notification)
[...]