diff options
| author | Rolf Eike Beer <eike-kernel@sf-tec.de> | 2006-09-29 04:59:46 -0400 |
|---|---|---|
| committer | Linus Torvalds <torvalds@g5.osdl.org> | 2006-09-29 12:18:10 -0400 |
| commit | 2aae4a108dab8b8bc92270335f6e4b5c146b32ae (patch) | |
| tree | e1bc601a3575d1ea25947564bcaf7abbe08b9d69 /kernel | |
| parent | d7ff0dbf45ee8a7c4802ff46844e6e8167b7f360 (diff) | |
[PATCH] Fix kerneldoc comments in kernel/timer.c
Some of the kerneldoc comments in this file are ignored since the lead-in
is malformed, using either "/*" or "/***" instead of "/**".
[rdunlap@xenotime.net: kerneldoc fixes]
Signed-off-by: Rolf Eike Beer <eike-kernel@sf-tec.de>
Acked-by: Alan Cox <alan@redhat.com>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Diffstat (limited to 'kernel')
| -rw-r--r-- | kernel/timer.c | 29 |
1 files changed, 17 insertions, 12 deletions
diff --git a/kernel/timer.c b/kernel/timer.c index 6c9fa80088ed..d644f4e9ca0c 100644 --- a/kernel/timer.c +++ b/kernel/timer.c | |||
| @@ -136,7 +136,7 @@ static void internal_add_timer(tvec_base_t *base, struct timer_list *timer) | |||
| 136 | list_add_tail(&timer->entry, vec); | 136 | list_add_tail(&timer->entry, vec); |
| 137 | } | 137 | } |
| 138 | 138 | ||
| 139 | /*** | 139 | /** |
| 140 | * init_timer - initialize a timer. | 140 | * init_timer - initialize a timer. |
| 141 | * @timer: the timer to be initialized | 141 | * @timer: the timer to be initialized |
| 142 | * | 142 | * |
| @@ -236,7 +236,7 @@ int __mod_timer(struct timer_list *timer, unsigned long expires) | |||
| 236 | 236 | ||
| 237 | EXPORT_SYMBOL(__mod_timer); | 237 | EXPORT_SYMBOL(__mod_timer); |
| 238 | 238 | ||
| 239 | /*** | 239 | /** |
| 240 | * add_timer_on - start a timer on a particular CPU | 240 | * add_timer_on - start a timer on a particular CPU |
| 241 | * @timer: the timer to be added | 241 | * @timer: the timer to be added |
| 242 | * @cpu: the CPU to start it on | 242 | * @cpu: the CPU to start it on |
| @@ -256,9 +256,10 @@ void add_timer_on(struct timer_list *timer, int cpu) | |||
| 256 | } | 256 | } |
| 257 | 257 | ||
| 258 | 258 | ||
| 259 | /*** | 259 | /** |
| 260 | * mod_timer - modify a timer's timeout | 260 | * mod_timer - modify a timer's timeout |
| 261 | * @timer: the timer to be modified | 261 | * @timer: the timer to be modified |
| 262 | * @expires: new timeout in jiffies | ||
| 262 | * | 263 | * |
| 263 | * mod_timer is a more efficient way to update the expire field of an | 264 | * mod_timer is a more efficient way to update the expire field of an |
| 264 | * active timer (if the timer is inactive it will be activated) | 265 | * active timer (if the timer is inactive it will be activated) |
| @@ -292,7 +293,7 @@ int mod_timer(struct timer_list *timer, unsigned long expires) | |||
| 292 | 293 | ||
| 293 | EXPORT_SYMBOL(mod_timer); | 294 | EXPORT_SYMBOL(mod_timer); |
| 294 | 295 | ||
| 295 | /*** | 296 | /** |
| 296 | * del_timer - deactive a timer. | 297 | * del_timer - deactive a timer. |
| 297 | * @timer: the timer to be deactivated | 298 | * @timer: the timer to be deactivated |
| 298 | * | 299 | * |
| @@ -324,7 +325,10 @@ int del_timer(struct timer_list *timer) | |||
| 324 | EXPORT_SYMBOL(del_timer); | 325 | EXPORT_SYMBOL(del_timer); |
| 325 | 326 | ||
| 326 | #ifdef CONFIG_SMP | 327 | #ifdef CONFIG_SMP |
| 327 | /* | 328 | /** |
| 329 | * try_to_del_timer_sync - Try to deactivate a timer | ||
| 330 | * @timer: timer do del | ||
| 331 | * | ||
| 328 | * This function tries to deactivate a timer. Upon successful (ret >= 0) | 332 | * This function tries to deactivate a timer. Upon successful (ret >= 0) |
| 329 | * exit the timer is not queued and the handler is not running on any CPU. | 333 | * exit the timer is not queued and the handler is not running on any CPU. |
| 330 | * | 334 | * |
| @@ -352,7 +356,7 @@ out: | |||
| 352 | return ret; | 356 | return ret; |
| 353 | } | 357 | } |
| 354 | 358 | ||
| 355 | /*** | 359 | /** |
| 356 | * del_timer_sync - deactivate a timer and wait for the handler to finish. | 360 | * del_timer_sync - deactivate a timer and wait for the handler to finish. |
| 357 | * @timer: the timer to be deactivated | 361 | * @timer: the timer to be deactivated |
| 358 | * | 362 | * |
| @@ -402,15 +406,15 @@ static int cascade(tvec_base_t *base, tvec_t *tv, int index) | |||
| 402 | return index; | 406 | return index; |
| 403 | } | 407 | } |
| 404 | 408 | ||
| 405 | /*** | 409 | #define INDEX(N) ((base->timer_jiffies >> (TVR_BITS + (N) * TVN_BITS)) & TVN_MASK) |
| 410 | |||
| 411 | /** | ||
| 406 | * __run_timers - run all expired timers (if any) on this CPU. | 412 | * __run_timers - run all expired timers (if any) on this CPU. |
| 407 | * @base: the timer vector to be processed. | 413 | * @base: the timer vector to be processed. |
| 408 | * | 414 | * |
| 409 | * This function cascades all vectors and executes all expired timer | 415 | * This function cascades all vectors and executes all expired timer |
| 410 | * vectors. | 416 | * vectors. |
| 411 | */ | 417 | */ |
| 412 | #define INDEX(N) ((base->timer_jiffies >> (TVR_BITS + (N) * TVN_BITS)) & TVN_MASK) | ||
| 413 | |||
| 414 | static inline void __run_timers(tvec_base_t *base) | 418 | static inline void __run_timers(tvec_base_t *base) |
| 415 | { | 419 | { |
| 416 | struct timer_list *timer; | 420 | struct timer_list *timer; |
| @@ -971,7 +975,7 @@ void __init timekeeping_init(void) | |||
| 971 | 975 | ||
| 972 | 976 | ||
| 973 | static int timekeeping_suspended; | 977 | static int timekeeping_suspended; |
| 974 | /* | 978 | /** |
| 975 | * timekeeping_resume - Resumes the generic timekeeping subsystem. | 979 | * timekeeping_resume - Resumes the generic timekeeping subsystem. |
| 976 | * @dev: unused | 980 | * @dev: unused |
| 977 | * | 981 | * |
| @@ -1107,7 +1111,7 @@ static void clocksource_adjust(struct clocksource *clock, s64 offset) | |||
| 1107 | clock->error -= (interval - offset) << (TICK_LENGTH_SHIFT - clock->shift); | 1111 | clock->error -= (interval - offset) << (TICK_LENGTH_SHIFT - clock->shift); |
| 1108 | } | 1112 | } |
| 1109 | 1113 | ||
| 1110 | /* | 1114 | /** |
| 1111 | * update_wall_time - Uses the current clocksource to increment the wall time | 1115 | * update_wall_time - Uses the current clocksource to increment the wall time |
| 1112 | * | 1116 | * |
| 1113 | * Called from the timer interrupt, must hold a write on xtime_lock. | 1117 | * Called from the timer interrupt, must hold a write on xtime_lock. |
| @@ -1471,8 +1475,9 @@ asmlinkage long sys_gettid(void) | |||
| 1471 | return current->pid; | 1475 | return current->pid; |
| 1472 | } | 1476 | } |
| 1473 | 1477 | ||
| 1474 | /* | 1478 | /** |
| 1475 | * sys_sysinfo - fill in sysinfo struct | 1479 | * sys_sysinfo - fill in sysinfo struct |
| 1480 | * @info: pointer to buffer to fill | ||
| 1476 | */ | 1481 | */ |
| 1477 | asmlinkage long sys_sysinfo(struct sysinfo __user *info) | 1482 | asmlinkage long sys_sysinfo(struct sysinfo __user *info) |
| 1478 | { | 1483 | { |
