Re: [PATCH] cpumask: fix function description kernel-doc notation

[Andy Shevchenko <andriy.shevchenko@linux.intel.com>]

On Mon, Jan 02, 2023 at 01:18:30PM -0800, Randy Dunlap wrote:
> Use kernel-doc notation for the function description to prevent
> a warning:
> 
> lib/cpumask.c:160: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Returns an arbitrary cpu within srcp1 & srcp2.

Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Thanks!

> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
>  lib/cpumask.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff -- a/lib/cpumask.c b/lib/cpumask.c
> --- a/lib/cpumask.c
> +++ b/lib/cpumask.c
> @@ -157,7 +157,7 @@ EXPORT_SYMBOL(cpumask_local_spread);
>  static DEFINE_PER_CPU(int, distribute_cpu_mask_prev);
>  
>  /**
> - * Returns an arbitrary cpu within srcp1 & srcp2.
> + * cpumask_any_and_distribute - Return an arbitrary cpu within srcp1 & srcp2.
>   *
>   * Iterated calls using the same srcp1 and srcp2 will be distributed within
>   * their intersection.

-- 
With Best Regards,
Andy Shevchenko