[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-Id: <200907301900.54202.bart.vanassche@gmail.com>
Date: Thu, 30 Jul 2009 19:00:53 +0200
From: Bart Van Assche <bart.vanassche@...il.com>
To: linux-kernel@...r.kernel.org
Cc: "Greg Kroah-Hartman" <gregkh@...e.de>, Ingo Molnar <mingo@...e.hu>
Subject: [PATCH 2.6.30] schedule_work() documentation improvements
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@...il.com>
Cc: Greg Kroah-Hartman <gregkh@...e.de>
Cc: Ingo Molnar <mingo@...e.hu>
diff -uprN orig/linux-2.6.30/kernel/workqueue.c linux-2.6.30/kernel/workqueue.c
--- orig/linux-2.6.30/kernel/workqueue.c 2009-06-10 05:05:27.000000000 +0200
+++ linux-2.6.30/kernel/workqueue.c 2009-07-30 18:58:07.000000000 +0200
@@ -603,7 +603,11 @@ static struct workqueue_struct *keventd_
* schedule_work - put work task in global workqueue
* @work: job to be done
*
- * This puts a job in the kernel-global workqueue.
+ * Returns zero if @work was already on the kernel-global workqueue and
+ * non-zero otherwise.
+ *
+ * This puts a job in the kernel-global workqueue if it was not already queued
+ * and leaves it in the same position on the kernel-global workqueue otherwise.
*/
int schedule_work(struct work_struct *work)
{
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Powered by blists - more mailing lists