summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Nisbet <nischris@gmail.com>2020-04-23 15:35:24 +1200
committerPetr Štetiar <ynezz@true.cz>2020-05-21 13:44:08 +0200
commit1db3e7df31d9f0ab24bcaa3fd17e81a9f3104615 (patch)
treef55639ff5861b858c20daf153bcf417ca37e54a9
parent7c4ef0d9ae28525f70c09ff77b71015408bc3e62 (diff)
downloadlibubox-1db3e7df31d9f0ab24bcaa3fd17e81a9f3104615.tar.gz
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>
-rw-r--r--runqueue.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/runqueue.h b/runqueue.h
index f182e4e..08879d4 100644
--- 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);