libubox: runqueue fix comment in header

The comment relating to the runqueue task structure 'cancel' callback
indicated that the callback 'calls' runqueue_task_complete, which
isn't quite right. The callback _should_ call runqueue_task_complete.

Signed-off-by: Chris Nisbet <nischris@gmail.com>

diff --git a/runqueue.h b/runqueue.h
index f182e4e347ac37f13b5c5767831ee80c5fbbaacb..08879d49d2fa590d9ac70aac1f60110f72425c9b 100644 (file)
--- a/runqueue.h
+++ b/runqueue.h
@@ -56,8 +56,8 @@ struct runqueue_task_type {
         * called to request cancelling a task
         *
         * int type is used as an optional hint for the method to be used when
-        * cancelling the task, e.g. a signal number for processes. Calls
-        * runqueue_task_complete when done.
+        * cancelling the task, e.g. a signal number for processes. The cancel
+        * callback should call runqueue_task_complete when done.
         */
        void (*cancel)(struct runqueue *q, struct runqueue_task *t, int type);