mirror of
https://github.com/linuxkit/linuxkit.git
synced 2025-11-04 12:59:07 +00:00
46 lines
1.5 KiB
Diff
46 lines
1.5 KiB
Diff
From ec5fd96756a5ba739aa063ec489a5969052b17a9 Mon Sep 17 00:00:00 2001
|
|
From: Thomas Gleixner <tglx@linutronix.de>
|
|
Date: Fri, 22 Dec 2017 15:51:15 +0100
|
|
Subject: [PATCH 066/414] 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 <tglx@linutronix.de>
|
|
Cc: rt@linutronix.de
|
|
Signed-off-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
|
|
---
|
|
lib/timerqueue.c | 8 +++++---
|
|
1 file 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)
|
|
{
|
|
--
|
|
2.17.0
|
|
|