workqueue: Fix manage_workers() RETURNS description
authorLibin <huawei.libin@huawei.com>
Wed, 21 Aug 2013 00:50:40 +0000 (08:50 +0800)
committerTejun Heo <tj@kernel.org>
Wed, 21 Aug 2013 14:32:09 +0000 (10:32 -0400)
No functional change. The comment of function manage_workers()
RETURNS description is obvious wrong, same as the CONTEXT.
Fix it.

Signed-off-by: Libin <huawei.libin@huawei.com>
Signed-off-by: Tejun Heo <tj@kernel.org>
kernel/workqueue.c

index eebd9a6..10f655e 100644 (file)
@@ -2034,8 +2034,11 @@ static bool maybe_destroy_workers(struct worker_pool *pool)
  * multiple times.  Does GFP_KERNEL allocations.
  *
  * RETURNS:
- * spin_lock_irq(pool->lock) which may be released and regrabbed
- * multiple times.  Does GFP_KERNEL allocations.
+ * %false if the pool don't need management and the caller can safely start
+ * processing works, %true indicates that the function released pool->lock
+ * and reacquired it to perform some management function and that the
+ * conditions that the caller verified while holding the lock before
+ * calling the function might no longer be true.
  */
 static bool manage_workers(struct worker *worker)
 {