[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>
This commit is contained in:
parent
c333526f48
commit
057647fc47
|
@ -99,7 +99,7 @@ static void __queue_work(struct cpu_workqueue_struct *cwq,
|
|||
* @wq: workqueue to use
|
||||
* @work: work to queue
|
||||
*
|
||||
* Returns non-zero if it was successfully added.
|
||||
* Returns 0 if @work was already on a queue, non-zero otherwise.
|
||||
*
|
||||
* We queue the work to the CPU it was submitted, but there is no
|
||||
* guarantee that it will be processed by that CPU.
|
||||
|
@ -138,7 +138,7 @@ static void delayed_work_timer_fn(unsigned long __data)
|
|||
* @work: work to queue
|
||||
* @delay: number of jiffies to wait before queueing
|
||||
*
|
||||
* Returns non-zero if it was successfully added.
|
||||
* Returns 0 if @work was already on a queue, non-zero otherwise.
|
||||
*/
|
||||
int fastcall queue_delayed_work(struct workqueue_struct *wq,
|
||||
struct work_struct *work, unsigned long delay)
|
||||
|
@ -169,7 +169,7 @@ EXPORT_SYMBOL_GPL(queue_delayed_work);
|
|||
* @work: work to queue
|
||||
* @delay: number of jiffies to wait before queueing
|
||||
*
|
||||
* Returns non-zero if it was successfully added.
|
||||
* Returns 0 if @work was already on a queue, non-zero otherwise.
|
||||
*/
|
||||
int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
|
||||
struct work_struct *work, unsigned long delay)
|
||||
|
|
Loading…
Reference in New Issue