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: 7b4967c532 ("cpumask: Add alloc_cpumask_var_node()")
Fixes: 839cad5fa5 ("cpumask: fix function description kernel-doc notation")
Fixes: 93ba139ba8 ("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>
This commit is contained in:
Randy Dunlap 2023-07-12 20:08:32 -07:00 committed by Yury Norov
parent fdf0eaf114
commit dcb60f9c40
2 changed files with 10 additions and 3 deletions

View File

@ -175,8 +175,8 @@ static inline unsigned int cpumask_first_zero(const struct cpumask *srcp)
/** /**
* cpumask_first_and - return the first cpu from *srcp1 & *srcp2 * cpumask_first_and - return the first cpu from *srcp1 & *srcp2
* @src1p: the first input * @srcp1: the first input
* @src2p: the second input * @srcp2: the second input
* *
* Returns >= nr_cpu_ids if no cpus set in both. See also cpumask_next_and(). * Returns >= nr_cpu_ids if no cpus set in both. See also cpumask_next_and().
*/ */
@ -1197,6 +1197,10 @@ cpumap_print_bitmask_to_buf(char *buf, const struct cpumask *mask,
/** /**
* cpumap_print_list_to_buf - copies the cpumask into the buffer as * cpumap_print_list_to_buf - copies the cpumask into the buffer as
* comma-separated list of cpus * comma-separated list of cpus
* @buf: the buffer to copy into
* @mask: the cpumask to copy
* @off: in the string from which we are copying, we copy to @buf
* @count: the maximum number of bytes to print
* *
* Everything is same with the above cpumap_print_bitmask_to_buf() * Everything is same with the above cpumap_print_bitmask_to_buf()
* except the print format. * except the print format.

View File

@ -45,6 +45,7 @@ EXPORT_SYMBOL(cpumask_next_wrap);
* alloc_cpumask_var_node - allocate a struct cpumask on a given node * alloc_cpumask_var_node - allocate a struct cpumask on a given node
* @mask: pointer to cpumask_var_t where the cpumask is returned * @mask: pointer to cpumask_var_t where the cpumask is returned
* @flags: GFP_ flags * @flags: GFP_ flags
* @node: memory node from which to allocate or %NUMA_NO_NODE
* *
* Only defined when CONFIG_CPUMASK_OFFSTACK=y, otherwise is * Only defined when CONFIG_CPUMASK_OFFSTACK=y, otherwise is
* a nop returning a constant 1 (in <linux/cpumask.h>) * a nop returning a constant 1 (in <linux/cpumask.h>)
@ -157,7 +158,9 @@ EXPORT_SYMBOL(cpumask_local_spread);
static DEFINE_PER_CPU(int, distribute_cpu_mask_prev); static DEFINE_PER_CPU(int, distribute_cpu_mask_prev);
/** /**
* cpumask_any_and_distribute - Return an arbitrary cpu within srcp1 & srcp2. * cpumask_any_and_distribute - Return an arbitrary cpu within src1p & src2p.
* @src1p: first &cpumask for intersection
* @src2p: second &cpumask for intersection
* *
* Iterated calls using the same srcp1 and srcp2 will be distributed within * Iterated calls using the same srcp1 and srcp2 will be distributed within
* their intersection. * their intersection.