cpumask: fix function description kernel-doc notation

rddunlap · YuryNorov · commit 839cad5fa54b · 2023-06-22T13:57:41.000-07:00
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 &amp; srcp2.

Signed-off-by: Randy Dunlap &lt;rdunlap@infradead.org&gt;
Reviewed-by: Andy Shevchenko &lt;andriy.shevchenko@linux.intel.com&gt;
Signed-off-by: Yury Norov &lt;yury.norov@gmail.com&gt;
diff --git 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.

Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,7 @@ EXPORT_SYMBOL(cpumask_local_spread);`
`157`	`157`	`static DEFINE_PER_CPU(int, distribute_cpu_mask_prev);`
`158`	`158`
`159`	`159`	`/**`
`160`		`- * Returns an arbitrary cpu within srcp1 & srcp2.`
	`160`	`+ * cpumask_any_and_distribute - Return an arbitrary cpu within srcp1 & srcp2.`
`161`	`161`	`*`
`162`	`162`	`* Iterated calls using the same srcp1 and srcp2 will be distributed within`
`163`	`163`	`* their intersection.`