linux-kernel - Re: [PATCH] libbpf: fix some incorrect @param descriptions in the comment of libbpf.h

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAEf4BzYevTS3_BRutFF=AcNtXROQn4d95jg6seQCMpxqpzqdMw@mail.gmail.com>
Date: Tue, 25 Nov 2025 16:13:50 -0800
From: Andrii Nakryiko <andrii.nakryiko@...il.com>
To: Jianyun Gao <jianyungao89@...il.com>
Cc: linux-kernel@...r.kernel.org, Alexei Starovoitov <ast@...nel.org>, 
	Daniel Borkmann <daniel@...earbox.net>, Andrii Nakryiko <andrii@...nel.org>, 
	Martin KaFai Lau <martin.lau@...ux.dev>, Eduard Zingerman <eddyz87@...il.com>, Song Liu <song@...nel.org>, 
	Yonghong Song <yonghong.song@...ux.dev>, John Fastabend <john.fastabend@...il.com>, 
	KP Singh <kpsingh@...nel.org>, Stanislav Fomichev <sdf@...ichev.me>, Hao Luo <haoluo@...gle.com>, 
	Jiri Olsa <jolsa@...nel.org>, 
	"open list:BPF [GENERAL] (Safe Dynamic Programs and Tools)" <bpf@...r.kernel.org>
Subject: Re: [PATCH] libbpf: fix some incorrect @param descriptions in the
 comment of libbpf.h

On Mon, Nov 17, 2025 at 7:30 PM Jianyun Gao <jianyungao89@...il.com> 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@...il.com>
> ---
>  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)

[...]