leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

timerqueue: Document return values of timerqueue_add/del()

Browse Source 
The return values of timerqueue_add/del() are not documented in the kernel doc
comment. Add proper documentation.

Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Sebastian Siewior <bigeasy@linutronix.de>
Cc: rt@linutronix.de
Cc: Paul McKenney <paulmck@linux.vnet.ibm.com>
Cc: Anna-Maria Gleixner <anna-maria@linutronix.de>
Link: https://lkml.kernel.org/r/20171222145337.872681338@linutronix.de
This commit is contained in:
Thomas Gleixner 2017-12-22 15:51:15 +01:00
parent fd45bb77ad
commit 9f4533cd73
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
lib/timerqueue.c
View File

@ -33,8 +33,9 @@
* @head: head of timerqueue * @head: head of timerqueue
* @node: timer node to be added * @node: timer node to be added
* *
* Adds the timer node to the timerqueue, sorted by the * Adds the timer node to the timerqueue, sorted by the node's expires
* node's expires value. * 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) bool timerqueue_add(struct timerqueue_head *head, struct timerqueue_node *node)
{ {
@ -70,7 +71,8 @@ EXPORT_SYMBOL_GPL(timerqueue_add);
* @head: head of timerqueue * @head: head of timerqueue
* @node: timer node to be removed * @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) bool timerqueue_del(struct timerqueue_head *head, struct timerqueue_node *node)
{ {