Skip to content

Commit dcb60f9

Browse files
rddunlapYuryNorov
authored andcommitted
cpumask: eliminate kernel-doc warnings
Update lib/cpumask.c and <linux/cpumask.h> to fix all kernel-doc warnings: include/linux/cpumask.h:185: warning: Function parameter or member 'srcp1' not described in 'cpumask_first_and' include/linux/cpumask.h:185: warning: Function parameter or member 'srcp2' not described in 'cpumask_first_and' include/linux/cpumask.h:185: warning: Excess function parameter 'src1p' description in 'cpumask_first_and' include/linux/cpumask.h:185: warning: Excess function parameter 'src2p' description in 'cpumask_first_and' lib/cpumask.c:59: warning: Function parameter or member 'node' not described in 'alloc_cpumask_var_node' lib/cpumask.c:169: warning: Function parameter or member 'src1p' not described in 'cpumask_any_and_distribute' lib/cpumask.c:169: warning: Function parameter or member 'src2p' not described in 'cpumask_any_and_distribute' Fixes: 7b4967c ("cpumask: Add alloc_cpumask_var_node()") Fixes: 839cad5 ("cpumask: fix function description kernel-doc notation") Fixes: 93ba139 ("cpumask: use find_first_and_bit()") Signed-off-by: Randy Dunlap <[email protected]> Reviewed-by: Andy Shevchenko <[email protected]> Signed-off-by: Yury Norov <[email protected]>
1 parent fdf0eaf commit dcb60f9

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

include/linux/cpumask.h

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,8 +175,8 @@ static inline unsigned int cpumask_first_zero(const struct cpumask *srcp)
175175

176176
/**
177177
* cpumask_first_and - return the first cpu from *srcp1 & *srcp2
178-
* @src1p: the first input
179-
* @src2p: the second input
178+
* @srcp1: the first input
179+
* @srcp2: the second input
180180
*
181181
* Returns >= nr_cpu_ids if no cpus set in both. See also cpumask_next_and().
182182
*/
@@ -1197,6 +1197,10 @@ cpumap_print_bitmask_to_buf(char *buf, const struct cpumask *mask,
11971197
/**
11981198
* cpumap_print_list_to_buf - copies the cpumask into the buffer as
11991199
* comma-separated list of cpus
1200+
* @buf: the buffer to copy into
1201+
* @mask: the cpumask to copy
1202+
* @off: in the string from which we are copying, we copy to @buf
1203+
* @count: the maximum number of bytes to print
12001204
*
12011205
* Everything is same with the above cpumap_print_bitmask_to_buf()
12021206
* except the print format.

lib/cpumask.c

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ EXPORT_SYMBOL(cpumask_next_wrap);
4545
* alloc_cpumask_var_node - allocate a struct cpumask on a given node
4646
* @mask: pointer to cpumask_var_t where the cpumask is returned
4747
* @flags: GFP_ flags
48+
* @node: memory node from which to allocate or %NUMA_NO_NODE
4849
*
4950
* Only defined when CONFIG_CPUMASK_OFFSTACK=y, otherwise is
5051
* a nop returning a constant 1 (in <linux/cpumask.h>)
@@ -157,7 +158,9 @@ EXPORT_SYMBOL(cpumask_local_spread);
157158
static DEFINE_PER_CPU(int, distribute_cpu_mask_prev);
158159

159160
/**
160-
* cpumask_any_and_distribute - Return an arbitrary cpu within srcp1 & srcp2.
161+
* cpumask_any_and_distribute - Return an arbitrary cpu within src1p & src2p.
162+
* @src1p: first &cpumask for intersection
163+
* @src2p: second &cpumask for intersection
161164
*
162165
* Iterated calls using the same srcp1 and srcp2 will be distributed within
163166
* their intersection.

0 commit comments

Comments
 (0)