Re: [PATCH][Doc] Fix kerneldoc comments in kernel/timer.c

["Randy.Dunlap" <rdunlap@xenotime.net>]

On Tue, 1 Aug 2006 16:31:39 +0200 Rolf Eike Beer wrote:

> Some of the kerneldoc comments in this file are ignored since the lead-in is
> malformed, using either "/*" or "/***" instead of "/**".
> 
> Signed-off-by: Rolf Eike Beer <eike-kernel@sf-tec.de>

> @@ -401,7 +405,7 @@ static int cascade(tvec_base_t *base, tv
>  	return index;
>  }
>  
> -/***
> +/**
>   * __run_timers - run all expired timers (if any) on this CPU.
>   * @base: the timer vector to be processed.
>   *

Thanks for the patch, Eike.  I noticed that __run_timers needs
some help.  Patch below.

---
From: Randy Dunlap <rdunlap@xenotime.net>

Fix function description + definition so that a #macro does
not come between them and interfere with the kernel-doc.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
---
 kernel/timer.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

--- linux-2618-rc3g2.orig/kernel/timer.c
+++ linux-2618-rc3g2/kernel/timer.c
@@ -405,6 +405,8 @@ static int cascade(tvec_base_t *base, tv
 	return index;
 }
 
+#define INDEX(N) ((base->timer_jiffies >> (TVR_BITS + (N) * TVN_BITS)) & TVN_MASK)
+
 /**
  * __run_timers - run all expired timers (if any) on this CPU.
  * @base: the timer vector to be processed.
@@ -412,8 +414,6 @@ static int cascade(tvec_base_t *base, tv
  * This function cascades all vectors and executes all expired timer
  * vectors.
  */
-#define INDEX(N) ((base->timer_jiffies >> (TVR_BITS + (N) * TVN_BITS)) & TVN_MASK)
-
 static inline void __run_timers(tvec_base_t *base)
 {
 	struct timer_list *timer;