* [PATCH] cpumask: fix function description kernel-doc notation
@ 2023-01-02 21:18 Randy Dunlap
2023-01-03 12:46 ` Andy Shevchenko
2023-03-02 7:09 ` Yury Norov
0 siblings, 2 replies; 3+ messages in thread
From: Randy Dunlap @ 2023-01-02 21:18 UTC (permalink / raw)
To: linux-kernel; +Cc: Yury Norov, Andy Shevchenko, Rasmus Villemoes, Randy Dunlap
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.
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.
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] cpumask: fix function description kernel-doc notation
2023-01-02 21:18 [PATCH] cpumask: fix function description kernel-doc notation Randy Dunlap
@ 2023-01-03 12:46 ` Andy Shevchenko
2023-03-02 7:09 ` Yury Norov
1 sibling, 0 replies; 3+ messages in thread
From: Andy Shevchenko @ 2023-01-03 12:46 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-kernel, Yury Norov, Rasmus Villemoes
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] cpumask: fix function description kernel-doc notation
2023-01-02 21:18 [PATCH] cpumask: fix function description kernel-doc notation Randy Dunlap
2023-01-03 12:46 ` Andy Shevchenko
@ 2023-03-02 7:09 ` Yury Norov
1 sibling, 0 replies; 3+ messages in thread
From: Yury Norov @ 2023-03-02 7:09 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-kernel, Andy Shevchenko, Rasmus Villemoes
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.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Applied, thanks.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-03-02 7:09 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-02 21:18 [PATCH] cpumask: fix function description kernel-doc notation Randy Dunlap
2023-01-03 12:46 ` Andy Shevchenko
2023-03-02 7:09 ` Yury Norov
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®