diff options
author | Randy Dunlap <rdunlap@xenotime.net> | 2005-11-07 04:01:06 -0500 |
---|---|---|
committer | Linus Torvalds <torvalds@g5.osdl.org> | 2005-11-07 10:53:55 -0500 |
commit | 1e5d533142c1c178a31d4cc81837eb078f9269bc (patch) | |
tree | 7708cc8667035ad7903f3c2c617a54240f2d6e77 | |
parent | 8a0d4900697f2d615a77cd99585e743c1af555a3 (diff) |
[PATCH] more kernel-doc cleanups, additions
Various core kernel-doc cleanups:
- add missing function parameters in ipc, irq/manage, kernel/sys,
kernel/sysctl, and mm/slab;
- move description to just above function for kernel_restart()
Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
-rw-r--r-- | ipc/util.c | 9 | ||||
-rw-r--r-- | kernel/irq/manage.c | 1 | ||||
-rw-r--r-- | kernel/sys.c | 15 | ||||
-rw-r--r-- | kernel/sysctl.c | 1 | ||||
-rw-r--r-- | mm/slab.c | 1 |
5 files changed, 17 insertions, 10 deletions
diff --git a/ipc/util.c b/ipc/util.c index 10e836d0d89e..23f1cec150c1 100644 --- a/ipc/util.c +++ b/ipc/util.c | |||
@@ -410,7 +410,8 @@ void ipc_rcu_getref(void *ptr) | |||
410 | } | 410 | } |
411 | 411 | ||
412 | /** | 412 | /** |
413 | * ipc_schedule_free - free ipc + rcu space | 413 | * ipc_schedule_free - free ipc + rcu space |
414 | * @head: RCU callback structure for queued work | ||
414 | * | 415 | * |
415 | * Since RCU callback function is called in bh, | 416 | * Since RCU callback function is called in bh, |
416 | * we need to defer the vfree to schedule_work | 417 | * we need to defer the vfree to schedule_work |
@@ -427,10 +428,10 @@ static void ipc_schedule_free(struct rcu_head *head) | |||
427 | } | 428 | } |
428 | 429 | ||
429 | /** | 430 | /** |
430 | * ipc_immediate_free - free ipc + rcu space | 431 | * ipc_immediate_free - free ipc + rcu space |
431 | * | 432 | * @head: RCU callback structure that contains pointer to be freed |
432 | * Free from the RCU callback context | ||
433 | * | 433 | * |
434 | * Free from the RCU callback context | ||
434 | */ | 435 | */ |
435 | static void ipc_immediate_free(struct rcu_head *head) | 436 | static void ipc_immediate_free(struct rcu_head *head) |
436 | { | 437 | { |
diff --git a/kernel/irq/manage.c b/kernel/irq/manage.c index 1cfdb08ddf20..3bd7226d15fa 100644 --- a/kernel/irq/manage.c +++ b/kernel/irq/manage.c | |||
@@ -24,6 +24,7 @@ cpumask_t __cacheline_aligned pending_irq_cpumask[NR_IRQS]; | |||
24 | 24 | ||
25 | /** | 25 | /** |
26 | * synchronize_irq - wait for pending IRQ handlers (on other CPUs) | 26 | * synchronize_irq - wait for pending IRQ handlers (on other CPUs) |
27 | * @irq: interrupt number to wait for | ||
27 | * | 28 | * |
28 | * This function waits for any pending IRQ handlers for this interrupt | 29 | * This function waits for any pending IRQ handlers for this interrupt |
29 | * to complete before returning. If you use this function while | 30 | * to complete before returning. If you use this function while |
diff --git a/kernel/sys.c b/kernel/sys.c index 1e1f41b3fdf6..3e332131000e 100644 --- a/kernel/sys.c +++ b/kernel/sys.c | |||
@@ -376,18 +376,21 @@ void emergency_restart(void) | |||
376 | } | 376 | } |
377 | EXPORT_SYMBOL_GPL(emergency_restart); | 377 | EXPORT_SYMBOL_GPL(emergency_restart); |
378 | 378 | ||
379 | /** | ||
380 | * kernel_restart - reboot the system | ||
381 | * | ||
382 | * Shutdown everything and perform a clean reboot. | ||
383 | * This is not safe to call in interrupt context. | ||
384 | */ | ||
385 | void kernel_restart_prepare(char *cmd) | 379 | void kernel_restart_prepare(char *cmd) |
386 | { | 380 | { |
387 | notifier_call_chain(&reboot_notifier_list, SYS_RESTART, cmd); | 381 | notifier_call_chain(&reboot_notifier_list, SYS_RESTART, cmd); |
388 | system_state = SYSTEM_RESTART; | 382 | system_state = SYSTEM_RESTART; |
389 | device_shutdown(); | 383 | device_shutdown(); |
390 | } | 384 | } |
385 | |||
386 | /** | ||
387 | * kernel_restart - reboot the system | ||
388 | * @cmd: pointer to buffer containing command to execute for restart | ||
389 | * or NULL | ||
390 | * | ||
391 | * Shutdown everything and perform a clean reboot. | ||
392 | * This is not safe to call in interrupt context. | ||
393 | */ | ||
391 | void kernel_restart(char *cmd) | 394 | void kernel_restart(char *cmd) |
392 | { | 395 | { |
393 | kernel_restart_prepare(cmd); | 396 | kernel_restart_prepare(cmd); |
diff --git a/kernel/sysctl.c b/kernel/sysctl.c index e1351200ce85..c4f35f96884d 100644 --- a/kernel/sysctl.c +++ b/kernel/sysctl.c | |||
@@ -1997,6 +1997,7 @@ int proc_dointvec_jiffies(ctl_table *table, int write, struct file *filp, | |||
1997 | * @filp: the file structure | 1997 | * @filp: the file structure |
1998 | * @buffer: the user buffer | 1998 | * @buffer: the user buffer |
1999 | * @lenp: the size of the user buffer | 1999 | * @lenp: the size of the user buffer |
2000 | * @ppos: pointer to the file position | ||
2000 | * | 2001 | * |
2001 | * Reads/writes up to table->maxlen/sizeof(unsigned int) integer | 2002 | * Reads/writes up to table->maxlen/sizeof(unsigned int) integer |
2002 | * values from/to the user buffer, treated as an ASCII string. | 2003 | * values from/to the user buffer, treated as an ASCII string. |
@@ -3263,6 +3263,7 @@ static void drain_array_locked(kmem_cache_t *cachep, | |||
3263 | 3263 | ||
3264 | /** | 3264 | /** |
3265 | * cache_reap - Reclaim memory from caches. | 3265 | * cache_reap - Reclaim memory from caches. |
3266 | * @unused: unused parameter | ||
3266 | * | 3267 | * |
3267 | * Called from workqueue/eventd every few seconds. | 3268 | * Called from workqueue/eventd every few seconds. |
3268 | * Purpose: | 3269 | * Purpose: |