Skip to content

Commit 214bfd2

Browse files
rddunlapAlexei Starovoitov
authored andcommitted
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: Randy 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: Alexei Starovoitov <ast@kernel.org>
1 parent d128860 commit 214bfd2

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

kernel/bpf/cgroup.c

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -785,7 +785,8 @@ static void replace_effective_prog(struct cgroup *cgrp,
785785
* to descendants
786786
* @cgrp: The cgroup which descendants to traverse
787787
* @link: A link for which to replace BPF program
788-
* @type: Type of attach operation
788+
* @new_prog: &struct bpf_prog for the target BPF program with its refcnt
789+
* incremented
789790
*
790791
* Must be called with cgroup_mutex held.
791792
*/
@@ -1334,7 +1335,7 @@ int cgroup_bpf_prog_query(const union bpf_attr *attr,
13341335
* __cgroup_bpf_run_filter_skb() - Run a program for packet filtering
13351336
* @sk: The socket sending or receiving traffic
13361337
* @skb: The skb that is being sent or received
1337-
* @type: The type of program to be executed
1338+
* @atype: The type of program to be executed
13381339
*
13391340
* If no socket is passed, or the socket is not of type INET or INET6,
13401341
* this function does nothing and returns 0.
@@ -1424,7 +1425,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_skb);
14241425
/**
14251426
* __cgroup_bpf_run_filter_sk() - Run a program on a sock
14261427
* @sk: sock structure to manipulate
1427-
* @type: The type of program to be executed
1428+
* @atype: The type of program to be executed
14281429
*
14291430
* socket is passed is expected to be of type INET or INET6.
14301431
*
@@ -1449,7 +1450,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_sk);
14491450
* provided by user sockaddr
14501451
* @sk: sock struct that will use sockaddr
14511452
* @uaddr: sockaddr struct provided by user
1452-
* @type: The type of program to be executed
1453+
* @atype: The type of program to be executed
14531454
* @t_ctx: Pointer to attach type specific context
14541455
* @flags: Pointer to u32 which contains higher bits of BPF program
14551456
* return value (OR'ed together).
@@ -1496,7 +1497,7 @@ EXPORT_SYMBOL(__cgroup_bpf_run_filter_sock_addr);
14961497
* @sock_ops: bpf_sock_ops_kern struct to pass to program. Contains
14971498
* sk with connection information (IP addresses, etc.) May not contain
14981499
* cgroup info if it is a req sock.
1499-
* @type: The type of program to be executed
1500+
* @atype: The type of program to be executed
15001501
*
15011502
* socket passed is expected to be of type INET or INET6.
15021503
*
@@ -1670,7 +1671,7 @@ const struct bpf_verifier_ops cg_dev_verifier_ops = {
16701671
* @ppos: value-result argument: value is position at which read from or write
16711672
* to sysctl is happening, result is new position if program overrode it,
16721673
* initial value otherwise
1673-
* @type: type of program to be executed
1674+
* @atype: type of program to be executed
16741675
*
16751676
* Program is run when sysctl is being accessed, either read or written, and
16761677
* can allow or deny such access.

0 commit comments

Comments
 (0)