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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <Y7Qjp/Bm6ckmaXbB@smile.fi.intel.com>
Date:   Tue, 3 Jan 2023 14:46:31 +0200
From:   Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org, Yury Norov <yury.norov@...il.com>,
        Rasmus Villemoes <linux@...musvillemoes.dk>
Subject: Re: [PATCH] cpumask: fix function description kernel-doc notation

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@...ux.intel.com>

Thanks!

> Signed-off-by: Randy Dunlap <rdunlap@...radead.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