renegade-project/linux-next
2
0
Fork 0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-16 17:23:55 +08:00
Code

workqueue: fix some docbook warnings

Browse Source 
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>
This commit is contained in:
Jonathan Corbet 2015-08-13 17:52:02 -06:00 committed by Tejun Heo
parent 1dadafa86a
commit 355c06633e
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/linux/workqueue.h
View File

@ -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 * delayed_work_pending - Find out whether a delayable work item is currently
* pending * pending
* @work: The work item in question * @w: The work item in question
*/ */
#define delayed_work_pending(w) \ #define delayed_work_pending(w) \
work_pending(&(w)->work) 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 * @fmt: printf format for the name of the workqueue
* @flags: WQ_* flags * @flags: WQ_* flags
* @max_active: max in-flight work items, 0 for default * @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 * Allocate a workqueue with the specified parameters. For detailed
* information on WQ_* flags, please refer to Documentation/workqueue.txt. * 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 * alloc_ordered_workqueue - allocate an ordered workqueue
* @fmt: printf format for the name of the workqueue * @fmt: printf format for the name of the workqueue
* @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful) * @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 * Allocate an ordered workqueue. An ordered workqueue executes at
* most one work item at any given time in the queued order. They are * most one work item at any given time in the queued order. They are