workqueues: Improve schedule_work() documentation
authorBart Van Assche <bart.vanassche@gmail.com>
Thu, 30 Jul 2009 17:00:53 +0000 (19:00 +0200)
committerIngo Molnar <mingo@elte.hu>
Tue, 4 Aug 2009 13:21:16 +0000 (15:21 +0200)
commit5b0f437df0a3e374d26ad533eb78fe64744f55a8
treeb450a583c3fea39baac8cdea13b152634cdea121
parenta33a052f19a21d727847391c8c1aff3fb221c472
workqueues: Improve schedule_work() documentation

Two important aspects of the schedule_work() function are not
yet documented:

 - that it is allowed to pass a struct work_struct * to this
   function that is already on the kernel-global workqueue;

 - the meaning of its return value.

The patch below documents both aspects.

Signed-off-by: Bart Van Assche <bart.vanassche@gmail.com>
Cc: "Greg Kroah-Hartman" <gregkh@suse.de>
Cc: Andrew Morton <akpm@linux-foundation.org>
LKML-Reference: <200907301900.54202.bart.vanassche@gmail.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
kernel/workqueue.c