aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2015-08-13 19:52:02 -0400
committerTejun Heo <tj@kernel.org>2015-08-17 15:48:24 -0400
commit355c06633e233a57155b827ebe99b91c35bc1f5c (patch)
tree15dc48298b0169be14be98275286106839790bb5
parent1dadafa86a779884f14a6e7a3ddde1a57b0a0a65 (diff)
workqueue: fix some docbook warnings
There are some errors in the docbook comments in workqueue.h that cause warnings when the docs are built; this only recently came to light because these comments were not used until now. Fix the comments to make the warnings go away. The "args..." "fix" is a hack. kerneldoc doesn't deal properly with named variadic arguments in macros, so all I've really achieved here is to make it shut up. Fixing kerneldoc will have to wait for more time. Signed-off-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Tejun Heo <tj@kernel.org>
-rw-r--r--include/linux/workqueue.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/linux/workqueue.h b/include/linux/workqueue.h
index 738b30b39b68..0197358f1e81 100644
--- a/include/linux/workqueue.h
+++ b/include/linux/workqueue.h
@@ -265,7 +265,7 @@ static inline unsigned int work_static(struct work_struct *work) { return 0; }
265/** 265/**
266 * delayed_work_pending - Find out whether a delayable work item is currently 266 * delayed_work_pending - Find out whether a delayable work item is currently
267 * pending 267 * pending
268 * @work: The work item in question 268 * @w: The work item in question
269 */ 269 */
270#define delayed_work_pending(w) \ 270#define delayed_work_pending(w) \
271 work_pending(&(w)->work) 271 work_pending(&(w)->work)
@@ -366,7 +366,7 @@ __alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
366 * @fmt: printf format for the name of the workqueue 366 * @fmt: printf format for the name of the workqueue
367 * @flags: WQ_* flags 367 * @flags: WQ_* flags
368 * @max_active: max in-flight work items, 0 for default 368 * @max_active: max in-flight work items, 0 for default
369 * @args: args for @fmt 369 * @args...: args for @fmt
370 * 370 *
371 * Allocate a workqueue with the specified parameters. For detailed 371 * Allocate a workqueue with the specified parameters. For detailed
372 * information on WQ_* flags, please refer to Documentation/workqueue.txt. 372 * information on WQ_* flags, please refer to Documentation/workqueue.txt.
@@ -398,7 +398,7 @@ __alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
398 * alloc_ordered_workqueue - allocate an ordered workqueue 398 * alloc_ordered_workqueue - allocate an ordered workqueue
399 * @fmt: printf format for the name of the workqueue 399 * @fmt: printf format for the name of the workqueue
400 * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful) 400 * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
401 * @args: args for @fmt 401 * @args...: args for @fmt
402 * 402 *
403 * Allocate an ordered workqueue. An ordered workqueue executes at 403 * Allocate an ordered workqueue. An ordered workqueue executes at
404 * most one work item at any given time in the queued order. They are 404 * most one work item at any given time in the queued order. They are