From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756575AbdLVOyg (ORCPT ); Fri, 22 Dec 2017 09:54:36 -0500 Received: from Galois.linutronix.de ([146.0.238.70]:57833 "EHLO Galois.linutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1756020AbdLVOyC (ORCPT ); Fri, 22 Dec 2017 09:54:02 -0500 Message-Id: <20171222145337.872681338@linutronix.de> User-Agent: quilt/0.63-1 Date: Fri, 22 Dec 2017 15:51:15 +0100 From: Thomas Gleixner To: LKML Cc: Anna-Maria Gleixner , Sebastian Siewior , Paul McKenney , Peter Zijlstra , Frederic Weisbecker , Ingo Molnar , rt@linutronix.de Subject: [patch 4/4] timerqueue: Document return values of timerqueue_add/del() References: <20171222145111.919609918@linutronix.de> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-15 Content-Disposition: inline; filename=timerqueue--Document_return_values_of_timerqueue_add-del--.patch Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Thomas Gleixner The return values of timerqueue_add/del() are not documented in the kernel doc comment. Add proper documentation. Signed-off-by: Thomas Gleixner Cc: rt@linutronix.de --- lib/timerqueue.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) --- 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) {