Commit 057647fc47b3a5fbcfa997041db3f483d506603c

Authored by Alan Stern
Committed by Linus Torvalds
1 parent c333526f48

[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>

Showing 1 changed file with 3 additions and 3 deletions Side-by-side Diff

... ... @@ -99,7 +99,7 @@
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,7 +138,7 @@
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,7 +169,7 @@
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)