lkml.org 
[lkml]   [2017]   [Apr]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    Date
    From
    Subject[patch V2 02/10] 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: Anna-Maria Gleixner <anna-maria@linutronix.de>
    Cc: John Stultz <john.stultz@linaro.org>
    Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
    ---
    lib/timerqueue.c | 8 +++++---
    1 file changed, 5 insertions(+), 3 deletions(-)

    Index: b/lib/timerqueue.c
    ===================================================================
    --- 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)
    {

    \
     
     \ /
      Last update: 2017-04-18 18:42    [W:2.260 / U:0.280 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site