Commit 214bfd26 authored by Randy Dunlap's avatar Randy Dunlap Committed by Alexei Starovoitov
Browse files

bpf, cgroup: fix multiple kernel-doc warnings 



Fix missing or extra function parameter kernel-doc warnings
in cgroup.c:

kernel/bpf/cgroup.c:1359: warning: Excess function parameter 'type' description in '__cgroup_bpf_run_filter_skb'
kernel/bpf/cgroup.c:1359: warning: Function parameter or member 'atype' not described in '__cgroup_bpf_run_filter_skb'
kernel/bpf/cgroup.c:1439: warning: Excess function parameter 'type' description in '__cgroup_bpf_run_filter_sk'
kernel/bpf/cgroup.c:1439: warning: Function parameter or member 'atype' not described in '__cgroup_bpf_run_filter_sk'
kernel/bpf/cgroup.c:1467: warning: Excess function parameter 'type' description in '__cgroup_bpf_run_filter_sock_addr'
kernel/bpf/cgroup.c:1467: warning: Function parameter or member 'atype' not described in '__cgroup_bpf_run_filter_sock_addr'
kernel/bpf/cgroup.c:1512: warning: Excess function parameter 'type' description in '__cgroup_bpf_run_filter_sock_ops'
kernel/bpf/cgroup.c:1512: warning: Function parameter or member 'atype' not described in '__cgroup_bpf_run_filter_sock_ops'
kernel/bpf/cgroup.c:1685: warning: Excess function parameter 'type' description in '__cgroup_bpf_run_filter_sysctl'
kernel/bpf/cgroup.c:1685: warning: Function parameter or member 'atype' not described in '__cgroup_bpf_run_filter_sysctl'
kernel/bpf/cgroup.c:795: warning: Excess function parameter 'type' description in '__cgroup_bpf_replace'
kernel/bpf/cgroup.c:795: warning: Function parameter or member 'new_prog' not described in '__cgroup_bpf_replace'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Martin KaFai Lau <martin.lau@linux.dev>
Cc: bpf@vger.kernel.org
Cc: Alexei Starovoitov <ast@kernel.org>
Cc: Daniel Borkmann <daniel@iogearbox.net>
Cc: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/r/20230912060812.1715-1-rdunlap@infradead.org


Signed-off-by: default avatarAlexei Starovoitov <ast@kernel.org>
parent d128860d

kernel/bpf/cgroup.c

+7 −6
Original line number Diff line number Diff line
@@ -785,7 +785,8 @@ static void replace_effective_prog(struct cgroup *cgrp, 
 *                          to descendants

 * @cgrp: The cgroup which descendants to traverse

 * @link: A link for which to replace BPF program

 * @type: Type of attach operation

 * @new_prog: &struct bpf_prog for the target BPF program with its refcnt

 *            incremented

 *

 * Must be called with cgroup_mutex held.

 */
@@ -1334,7 +1335,7 @@ int cgroup_bpf_prog_query(const union bpf_attr *attr, 
 * __cgroup_bpf_run_filter_skb() - Run a program for packet filtering

 * @sk: The socket sending or receiving traffic

 * @skb: The skb that is being sent or received

 * @type: The type of program to be executed

 * @atype: The type of program to be executed

 *

 * If no socket is passed, or the socket is not of type INET or INET6,

 * this function does nothing and returns 0.
@@ -1424,7 +1425,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_skb); 
/**

 * __cgroup_bpf_run_filter_sk() - Run a program on a sock

 * @sk: sock structure to manipulate

 * @type: The type of program to be executed

 * @atype: The type of program to be executed

 *

 * socket is passed is expected to be of type INET or INET6.

 *
@@ -1449,7 +1450,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_sk); 
 *                                       provided by user sockaddr

 * @sk: sock struct that will use sockaddr

 * @uaddr: sockaddr struct provided by user

 * @type: The type of program to be executed

 * @atype: The type of program to be executed

 * @t_ctx: Pointer to attach type specific context

 * @flags: Pointer to u32 which contains higher bits of BPF program

 *         return value (OR'ed together).
@@ -1496,7 +1497,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_sock_addr); 
 * @sock_ops: bpf_sock_ops_kern struct to pass to program. Contains

 * sk with connection information (IP addresses, etc.) May not contain

 * cgroup info if it is a req sock.

 * @type: The type of program to be executed

 * @atype: The type of program to be executed

 *

 * socket passed is expected to be of type INET or INET6.

 *
@@ -1670,7 +1671,7 @@ const struct bpf_verifier_ops cg_dev_verifier_ops = { 
 * @ppos: value-result argument: value is position at which read from or write

 *	to sysctl is happening, result is new position if program overrode it,

 *	initial value otherwise

 * @type: type of program to be executed

 * @atype: type of program to be executed

 *

 * Program is run when sysctl is being accessed, either read or written, and

 * can allow or deny such access.