Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: 7b4967c53204 ("cpumask: Add alloc_cpumask_var_node()")
Fixes: 839cad5fa54b ("cpumask: fix function description kernel-doc notation")
Fixes: 93ba139ba819 ("cpumask: use find_first_and_bit()")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Yury Norov <yury.norov@gmail.com>

authored by

Randy Dunlap and committed by
Yury Norov
dcb60f9c fdf0eaf1

+10 -3
+6 -2
include/linux/cpumask.h
··· 175 175 176 176 /** 177 177 * 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 180 180 * 181 181 * Returns >= nr_cpu_ids if no cpus set in both. See also cpumask_next_and(). 182 182 */ ··· 1197 1197 /** 1198 1198 * cpumap_print_list_to_buf - copies the cpumask into the buffer as 1199 1199 * 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 1200 1204 * 1201 1205 * Everything is same with the above cpumap_print_bitmask_to_buf() 1202 1206 * except the print format.
+4 -1
lib/cpumask.c
··· 45 45 * alloc_cpumask_var_node - allocate a struct cpumask on a given node 46 46 * @mask: pointer to cpumask_var_t where the cpumask is returned 47 47 * @flags: GFP_ flags 48 + * @node: memory node from which to allocate or %NUMA_NO_NODE 48 49 * 49 50 * Only defined when CONFIG_CPUMASK_OFFSTACK=y, otherwise is 50 51 * a nop returning a constant 1 (in <linux/cpumask.h>) ··· 158 157 static DEFINE_PER_CPU(int, distribute_cpu_mask_prev); 159 158 160 159 /** 161 - * cpumask_any_and_distribute - Return an arbitrary cpu within srcp1 & srcp2. 160 + * cpumask_any_and_distribute - Return an arbitrary cpu within src1p & src2p. 161 + * @src1p: first &cpumask for intersection 162 + * @src2p: second &cpumask for intersection 162 163 * 163 164 * Iterated calls using the same srcp1 and srcp2 will be distributed within 164 165 * their intersection.