Commit b87752ef authored by Randy Dunlap's avatar Randy Dunlap Committed by Ingo Molnar
Browse files

timers: Fix kernel-doc format and add Return values 



Fix kernel-doc format and warnings:

  timer.h:26: warning: Cannot understand  * @TIMER_DEFERRABLE: A deferrable timer will work normally when the on line 26 - I thought it was a doc line
  timer.h:146: warning: No description found for return value of 'timer_pending'
  timer.h:180: warning: No description found for return value of 'del_timer_sync'
  timer.h:193: warning: No description found for return value of 'del_timer'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarIngo Molnar <mingo@kernel.org>
Link: https://lore.kernel.org/r/20240331172652.14086-4-rdunlap@infradead.org
parent 76f788ee

include/linux/timer.h

+10 −2
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ 
#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn)

#endif



/**

/*

 * @TIMER_DEFERRABLE: A deferrable timer will work normally when the

 * system is busy, but will not cause a CPU to come out of idle just

 * to service it; instead, the timer will be serviced when the CPU
@@ -140,7 +140,7 @@ static inline void destroy_timer_on_stack(struct timer_list *timer) { } 
 * or not. Callers must ensure serialization wrt. other operations done

 * to this timer, eg. interrupt contexts, or other CPUs on SMP.

 *

 * return value: 1 if the timer is pending, 0 if not.

 * Returns: 1 if the timer is pending, 0 if not.

 */

static inline int timer_pending(const struct timer_list * timer)

{
@@ -175,6 +175,10 @@ extern int timer_shutdown(struct timer_list *timer); 
 * See timer_delete_sync() for detailed explanation.

 *

 * Do not use in new code. Use timer_delete_sync() instead.

 *

 * Returns:

 * * %0	- The timer was not pending

 * * %1	- The timer was pending and deactivated

 */

static inline int del_timer_sync(struct timer_list *timer)

{
@@ -188,6 +192,10 @@ static inline int del_timer_sync(struct timer_list *timer) 
 * See timer_delete() for detailed explanation.

 *

 * Do not use in new code. Use timer_delete() instead.

 *

 * Returns:

 * * %0	- The timer was not pending

 * * %1	- The timer was pending and deactivated

 */

static inline int del_timer(struct timer_list *timer)

{