From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751246AbdL2Wu5 (ORCPT ); Fri, 29 Dec 2017 17:50:57 -0500 Received: from terminus.zytor.com ([65.50.211.136]:59329 "EHLO terminus.zytor.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750800AbdL2Wuw (ORCPT ); Fri, 29 Dec 2017 17:50:52 -0500 Date: Fri, 29 Dec 2017 14:47:30 -0800 From: tip-bot for Thomas Gleixner Message-ID: Cc: tglx@linutronix.de, fweisbec@gmail.com, mingo@kernel.org, bigeasy@linutronix.de, anna-maria@linutronix.de, peterz@infradead.org, linux-kernel@vger.kernel.org, paulmck@linux.vnet.ibm.com, hpa@zytor.com Reply-To: hpa@zytor.com, paulmck@linux.vnet.ibm.com, linux-kernel@vger.kernel.org, fweisbec@gmail.com, mingo@kernel.org, tglx@linutronix.de, peterz@infradead.org, anna-maria@linutronix.de, bigeasy@linutronix.de In-Reply-To: <20171222145337.872681338@linutronix.de> References: <20171222145337.872681338@linutronix.de> To: linux-tip-commits@vger.kernel.org Subject: [tip:timers/urgent] timerqueue: Document return values of timerqueue_add/del() Git-Commit-ID: 9f4533cd7334235cd4c9b9fb1b0b8791e2ba01a7 X-Mailer: tip-git-log-daemon Robot-ID: Robot-Unsubscribe: Contact to get blacklisted from these emails MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset=UTF-8 Content-Disposition: inline Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Commit-ID: 9f4533cd7334235cd4c9b9fb1b0b8791e2ba01a7 Gitweb: https://git.kernel.org/tip/9f4533cd7334235cd4c9b9fb1b0b8791e2ba01a7 Author: Thomas Gleixner AuthorDate: Fri, 22 Dec 2017 15:51:15 +0100 Committer: Thomas Gleixner 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 Cc: Peter Zijlstra Cc: Frederic Weisbecker Cc: Sebastian Siewior Cc: rt@linutronix.de Cc: Paul McKenney Cc: Anna-Maria Gleixner 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) {