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>
This commit is contained in:
Chris Nisbet 2020-04-23 15:35:24 +12:00 committed by Petr Štetiar
parent 7c4ef0d9ae
commit 1db3e7df31

View file

@ -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);