bpf: Fix bpf_cgroup_from_id() doxygen header
PATCH 1/1 bpf: Fix bpf_cgroup_from_id() doxygen header
In commit 332ea1f697be ("bpf: Add bpf_cgroup_from_id() kfunc"), a new bpf_cgroup_from_id() kfunc was added which allows a BPF program to lookup and acquire a reference to a cgroup from a cgroup id. The commit's doxygen comment seems to have copy-pasted fields, which causes BPF kfunc helper documentation to fail to render:
<snip>/helpers.c:2114: warning: Excess function parameter 'cgrp'... <snip>/helpers.c:2114: warning: Excess function parameter 'level'...
<snip>
<snip>/helpers.c:2114: warning: Excess function parameter 'level'...
This patch fixes the doxygen header.
--- kernel/bpf/helpers.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
kernel/bpf/helpers.c +1 -2
@@ -2106,8 +2106,7 @@ __bpf_kfunc struct cgroup *bpf_cgroup_ancestor(struct cgroup *cgrp, int level)* bpf_cgroup_from_id - Find a cgroup from its ID. A cgroup returned by this * kfunc which is not subsequently stored in a map, must be released by calling * bpf_cgroup_release(). -* @cgrp: The cgroup for which we're performing a lookup. -* @level: The level of ancestor to look up. +* @cgid: cgroup id. */ __bpf_kfunc struct cgroup *bpf_cgroup_from_id(u64 cgid) {
Signature · 1 line
2.39.0
Quoted 9 lines · David Vernet
In commit
332ea1f697be("bpf: Addbpf_cgroup_from_id()kfunc"), a newbpf_cgroup_from_id()kfunc was added which allows a BPF program to lookup and acquire a reference to a cgroup from a cgroup id. The commit's doxygen comment seems to have copy-pasted fields, which causes BPF kfunc helper documentation to fail to render:<snip>/helpers.c:2114: warning: Excess function parameter 'cgrp'... <snip>/helpers.c:2114: warning: Excess function parameter 'level'...
Quoted 8 lines
<snip>
<snip>/helpers.c:2114: warning: Excess function parameter 'level'...
This patch fixes the doxygen header.
Fixes 332ea1f697be ("bpf: Add bpf_cgroup_from_id() kfunc")Signed-off-by David Vernet <[email protected]>
This patch was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Hello:
This patch was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Quoted 10 lines · On Tue, 28 Feb 2023 09:28:45 -0600 you wrote:
In commit
332ea1f697be("bpf: Addbpf_cgroup_from_id()kfunc"), a newbpf_cgroup_from_id()kfunc was added which allows a BPF program to lookup and acquire a reference to a cgroup from a cgroup id. The commit's doxygen comment seems to have copy-pasted fields, which causes BPF kfunc helper documentation to fail to render:<snip>/helpers.c:2114: warning: Excess function parameter 'cgrp'... <snip>/helpers.c:2114: warning: Excess function parameter 'level'...
[...]
Here is the summary with links:
- [bpf-next] bpf: Fix bpf_cgroup_from_id() doxygen header
https://git.kernel.org/bpf/bpf-next/c/30a2d8328d8a
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html