Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
[PATCH] workqueue: update kerneldoc
This patch (as812) changes the kerneldoc comments explaining the return
values from queue_work(), queue_delayed_work(), and
queue_delayed_work_on(). The updated comments explain more accurately the
meaning of the return code and avoid suggesting that a 0 value means the
routine was unsuccessful.
Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
authored by Alan Stern and committed by Linus Torvalds 057647fc c333526f
+3
-3
kernel/workqueue.c
+3
-3
kernel/workqueue.c
···
99
99
* @wq: workqueue to use
100
100
* @work: work to queue
101
101
*
102
-
* Returns non-zero if it was successfully added.
102
+
* Returns 0 if @work was already on a queue, non-zero otherwise.
103
103
*
104
104
* We queue the work to the CPU it was submitted, but there is no
105
105
* guarantee that it will be processed by that CPU.
···
138
138
* @work: work to queue
139
139
* @delay: number of jiffies to wait before queueing
140
140
*
141
-
* Returns non-zero if it was successfully added.
141
+
* Returns 0 if @work was already on a queue, non-zero otherwise.
142
142
*/
143
143
int fastcall queue_delayed_work(struct workqueue_struct *wq,
144
144
struct work_struct *work, unsigned long delay)
···
169
169
* @work: work to queue
170
170
* @delay: number of jiffies to wait before queueing
171
171
*
172
-
* Returns non-zero if it was successfully added.
172
+
* Returns 0 if @work was already on a queue, non-zero otherwise.
173
173
*/
174
174
int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
175
175
struct work_struct *work, unsigned long delay)