[PATCH] workqueue: fix some docbook warnings

[PATCH] workqueue: fix some docbook warnings

[Jonathan Corbet]

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>
---
Say the word if you'd like me to keep this in the docs tree.

 include/linux/workqueue.h | 6 +++---
 1 file 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; }
 /**
  * delayed_work_pending - Find out whether a delayable work item is currently
  * pending
- * @work: The work item in question
+ * @w: The work item in question
  */
 #define delayed_work_pending(w) \
 	work_pending(&(w)->work)
@@ -366,7 +366,7 @@ __alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
  * @fmt: printf format for the name of the workqueue
  * @flags: WQ_* flags
  * @max_active: max in-flight work items, 0 for default
- * @args: args for @fmt
+ * @args...: args for @fmt
  *
  * Allocate a workqueue with the specified parameters.  For detailed
  * 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,
  * alloc_ordered_workqueue - allocate an ordered workqueue
  * @fmt: printf format for the name of the workqueue
  * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
- * @args: args for @fmt
+ * @args...: args for @fmt
  *
  * Allocate an ordered workqueue.  An ordered workqueue executes at
  * most one work item at any given time in the queued order.  They are
-- 
2.4.3

Re: [PATCH] workqueue: fix some docbook warnings

[Tejun Heo]

On Thu, Aug 13, 2015 at 05:52:02PM -0600, Jonathan Corbet wrote:
> 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>
> ---
> Say the word if you'd like me to keep this in the docs tree.

Ooh, saw this after applying.  :)

Applied to wq/for-4.3.

Thanks.

-- 
tejun