History

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.

Thomas Gleixner committed 8 years ago

Commit 9f4533c1 parent fd45bb71 file · +5 −3Browse files

Showing the changes to lib/timerqueue.c (1 of 1 file). Show all

Unified · Split

lib/timerqueue.c+5−3
@@ -33,8 +33,9 @@ · 32 unmodified lines
3333 * @head: head of timerqueue
3434 * @node: timer node to be added
3535 *
36− * Adds the timer node to the timerqueue, sorted by the
37− * node's expires value.
36+ * Adds the timer node to the timerqueue, sorted by the node's expires
37+ * value. Returns true if the newly added timer is the first expiring timer in
38+ * the queue.
3839 */
3940 bool timerqueue_add(struct timerqueue_head *head, struct timerqueue_node *node)
4041 {
@@ -70,7 +71,8 @@ EXPORT_SYMBOL_GPL(timerqueue_add); · 29 unmodified lines
7071 * @head: head of timerqueue
7172 * @node: timer node to be removed
7273 *
73− * Removes the timer node from the timerqueue.
74+ * Removes the timer node from the timerqueue. Returns true if the queue is
75+ * not empty after the remove.
7476 */
7577 bool timerqueue_del(struct timerqueue_head *head, struct timerqueue_node *node)
7678 {

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t