| Message ID | 20230228152845.294695-1-void@manifault.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 30a2d8328d8ac1bb0a6bf73f4f4cf03f4f5977cc |
| Delegated to: | BPF |
| Headers | show |
| Series | [bpf-next] bpf: Fix bpf_cgroup_from_id() doxygen header | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Clearly marked for bpf-next |
| netdev/apply | success | Patch already applied to bpf-next |
On 2/28/23 7:28 AM, David Vernet wrote: > 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. > > Fixes: 332ea1f697be ("bpf: Add bpf_cgroup_from_id() kfunc") > Signed-off-by: David Vernet <void@manifault.com> Acked-by: Yonghong Song <yhs@fb.com>
Hello: This patch was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <ast@kernel.org>: On Tue, 28 Feb 2023 09:28:45 -0600 you wrote: > 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'... > > [...] 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!
diff --git a/kernel/bpf/helpers.c b/kernel/bpf/helpers.c index a784be6f8bac..abdcc52f90a6 100644 --- a/kernel/bpf/helpers.c +++ b/kernel/bpf/helpers.c @@ -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) {
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. Fixes: 332ea1f697be ("bpf: Add bpf_cgroup_from_id() kfunc") Signed-off-by: David Vernet <void@manifault.com> --- kernel/bpf/helpers.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)