diff options
| author | Thomas Gleixner <[email protected]> | 2017-12-22 14:51:15 +0000 |
|---|---|---|
| committer | Thomas Gleixner <[email protected]> | 2017-12-29 22:13:10 +0000 |
| commit | 9f4533cd7334235cd4c9b9fb1b0b8791e2ba01a7 (patch) | |
| tree | e9fc7fc15eec19b69a23459f4420d12b1b1842fa /lib/timerqueue.c | |
| parent | timers: Invoke timer_start_debug() where it makes sense (diff) | |
| download | kernel-9f4533cd7334235cd4c9b9fb1b0b8791e2ba01a7.tar.gz kernel-9f4533cd7334235cd4c9b9fb1b0b8791e2ba01a7.zip | |
timerqueue: Document return values of timerqueue_add/del()
The return values of timerqueue_add/del() are not documented in the kernel doc
comment. Add proper documentation.
Signed-off-by: Thomas Gleixner <[email protected]>
Cc: Peter Zijlstra <[email protected]>
Cc: Frederic Weisbecker <[email protected]>
Cc: Sebastian Siewior <[email protected]>
Cc: [email protected]
Cc: Paul McKenney <[email protected]>
Cc: Anna-Maria Gleixner <[email protected]>
Link: https://lkml.kernel.org/r/[email protected]
Diffstat (limited to 'lib/timerqueue.c')
| -rw-r--r-- | lib/timerqueue.c | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/timerqueue.c b/lib/timerqueue.c index 4a720ed4fdaf..0d54bcbc8170 100644 --- a/lib/timerqueue.c +++ b/lib/timerqueue.c @@ -33,8 +33,9 @@ * @head: head of timerqueue * @node: timer node to be added * - * Adds the timer node to the timerqueue, sorted by the - * node's expires value. + * Adds the timer node to the timerqueue, sorted by the node's expires + * value. Returns true if the newly added timer is the first expiring timer in + * the queue. */ bool timerqueue_add(struct timerqueue_head *head, struct timerqueue_node *node) { @@ -70,7 +71,8 @@ EXPORT_SYMBOL_GPL(timerqueue_add); * @head: head of timerqueue * @node: timer node to be removed * - * Removes the timer node from the timerqueue. + * Removes the timer node from the timerqueue. Returns true if the queue is + * not empty after the remove. */ bool timerqueue_del(struct timerqueue_head *head, struct timerqueue_node *node) { |