workqueue: Use "@..." in function comment to describe variable length argument

htejun · htejun · commit 51da7f68edae · 2024-04-22T10:08:04.000-10:00
Previously, it was using "remaining args" without leading "@" which isn't
valid. Let's follow snprintf()'s example and use "@...".

Signed-off-by: Tejun Heo &lt;tj@kernel.org&gt;
Reported-by: Stephen Rothwell &lt;sfr@canb.auug.org.au&gt;
diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
@@ -473,7 +473,7 @@ void workqueue_softirq_dead(unsigned int cpu);
  * @fmt: printf format for the name of the workqueue
  * @flags: WQ_* flags
  * @max_active: max in-flight work items, 0 for default
- * remaining args: args for @fmt
+ * @...: args for @fmt
  *
  * For a per-cpu workqueue, @max_active limits the number of in-flight work
  * items for each CPU. e.g. @max_active of 1 indicates that each CPU can be

Original file line number	Diff line number	Diff line change
`@@ -473,7 +473,7 @@ void workqueue_softirq_dead(unsigned int cpu);`
`473`	`473`	`* @fmt: printf format for the name of the workqueue`
`474`	`474`	`* @flags: WQ_* flags`
`475`	`475`	`* @max_active: max in-flight work items, 0 for default`
`476`		`- * remaining args: args for @fmt`
	`476`	`+ * @...: args for @fmt`
`477`	`477`	`*`
`478`	`478`	`* For a per-cpu workqueue, @max_active limits the number of in-flight work`
`479`	`479`	`* items for each CPU. e.g. @max_active of 1 indicates that each CPU can be`