linux-kernel - [tip:timers/urgent] timerqueue: Document return values of timerqueue

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <tip-9f4533cd7334235cd4c9b9fb1b0b8791e2ba01a7@git.kernel.org>
Date:   Fri, 29 Dec 2017 14:47:30 -0800
From:   tip-bot for Thomas Gleixner <tipbot@...or.com>
To:     linux-tip-commits@...r.kernel.org
Cc:     tglx@...utronix.de, fweisbec@...il.com, mingo@...nel.org,
        bigeasy@...utronix.de, anna-maria@...utronix.de,
        peterz@...radead.org, linux-kernel@...r.kernel.org,
        paulmck@...ux.vnet.ibm.com, hpa@...or.com
Subject: [tip:timers/urgent] timerqueue: Document return values of
 timerqueue_add/del()

Commit-ID:  9f4533cd7334235cd4c9b9fb1b0b8791e2ba01a7
Gitweb:     https://git.kernel.org/tip/9f4533cd7334235cd4c9b9fb1b0b8791e2ba01a7
Author:     Thomas Gleixner <tglx@...utronix.de>
AuthorDate: Fri, 22 Dec 2017 15:51:15 +0100
Committer:  Thomas Gleixner <tglx@...utronix.de>
CommitDate: Fri, 29 Dec 2017 23:13:10 +0100

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@...utronix.de>
Cc: Peter Zijlstra <peterz@...radead.org>
Cc: Frederic Weisbecker <fweisbec@...il.com>
Cc: Sebastian Siewior <bigeasy@...utronix.de>
Cc: rt@...utronix.de
Cc: Paul McKenney <paulmck@...ux.vnet.ibm.com>
Cc: Anna-Maria Gleixner <anna-maria@...utronix.de>
Link: https://lkml.kernel.org/r/20171222145337.872681338@linutronix.de

---
 lib/timerqueue.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/lib/timerqueue.c b/lib/timerqueue.c
index 4a720ed..0d54bcb 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)
 {