Skip to contentSkip to conversation

timers: add missing kernel-doc

PATCH In review Randy Dunlap 1 participant 2 messages Apr 2, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 timers: add missing kernel-doc

From: Randy Dunlap <[email protected]>

Add missing kernel-doc parameter notation and change function name to its new name:

Warning(kernel/timer.c:543): No description found for parameter 'name' Warning(kernel/timer.c:543): No description found for parameter 'key'

---
 kernel/timer.c |    7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
kernel/timer.c +5 -2
@@ -531,10 +531,13 @@ static void __init_timer(struct timer_li
 }
 
 /**
- * init_timer - initialize a timer.
+ * init_timer_key - initialize a timer
  * @timer: the timer to be initialized
+ * @name: name of the timer
+ * @key: lockdep class key of the fake lock used for tracking timer
+ *       sync lock dependencies
  *
- * init_timer() must be done to a timer prior calling *any* of the
+ * init_timer_key() must be done to a timer prior calling *any* of the
  * other timer functions.
  */
 void init_timer_key(struct timer_list *timer,
#1 lore raw
Commit-ID:  633fe795b80693a8198e7d82f66538a72d2bbba2
Gitweb:     http://git.kernel.org/tip/633fe795b80693a8198e7d82f66538a72d2bbba2
Author:     Randy Dunlap <[email protected]>
AuthorDate: Wed, 1 Apr 2009 17:47:23 -0700
Committer:  Ingo Molnar <[email protected]>
CommitDate: Thu, 2 Apr 2009 05:54:00 +0200

timers: add missing kernel-doc

Add missing kernel-doc parameter notation and change function name to its new name:

Warning(kernel/timer.c:543): No description found for parameter 'name' Warning(kernel/timer.c:543): No description found for parameter 'key'

LKML-Reference: <[email protected]>

---
 kernel/timer.c |    7 +++++--
 1 files changed, 5 insertions(+), 2 deletions(-)
kernel/timer.c +5 -2
index 9b77fc9..3af9a0b 100644
@@ -524,10 +524,13 @@ static void __init_timer(struct timer_list *timer)
 }
 
 /**
- * init_timer - initialize a timer.
+ * init_timer_key - initialize a timer
  * @timer: the timer to be initialized
+ * @name: name of the timer
+ * @key: lockdep class key of the fake lock used for tracking timer
+ *       sync lock dependencies
  *
- * init_timer() must be done to a timer prior calling *any* of the
+ * init_timer_key() must be done to a timer prior calling *any* of the
  * other timer functions.
  */
 void init_timer(struct timer_list *timer)