[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>
This commit is contained in:
Randy Dunlap 2005-11-07 01:01:06 -08:00 committed by Linus Torvalds
parent 8a0d490069
commit 1e5d533142
5 changed files with 17 additions and 10 deletions

View file

@ -410,7 +410,8 @@ void ipc_rcu_getref(void *ptr)
} }
/** /**
* ipc_schedule_free - free ipc + rcu space * ipc_schedule_free - free ipc + rcu space
* @head: RCU callback structure for queued work
* *
* Since RCU callback function is called in bh, * Since RCU callback function is called in bh,
* we need to defer the vfree to schedule_work * we need to defer the vfree to schedule_work
@ -427,10 +428,10 @@ static void ipc_schedule_free(struct rcu_head *head)
} }
/** /**
* ipc_immediate_free - free ipc + rcu space * ipc_immediate_free - free ipc + rcu space
* * @head: RCU callback structure that contains pointer to be freed
* Free from the RCU callback context
* *
* Free from the RCU callback context
*/ */
static void ipc_immediate_free(struct rcu_head *head) static void ipc_immediate_free(struct rcu_head *head)
{ {

View file

@ -24,6 +24,7 @@ cpumask_t __cacheline_aligned pending_irq_cpumask[NR_IRQS];
/** /**
* synchronize_irq - wait for pending IRQ handlers (on other CPUs) * synchronize_irq - wait for pending IRQ handlers (on other CPUs)
* @irq: interrupt number to wait for
* *
* This function waits for any pending IRQ handlers for this interrupt * This function waits for any pending IRQ handlers for this interrupt
* to complete before returning. If you use this function while * to complete before returning. If you use this function while

View file

@ -376,18 +376,21 @@ void emergency_restart(void)
} }
EXPORT_SYMBOL_GPL(emergency_restart); EXPORT_SYMBOL_GPL(emergency_restart);
/**
* kernel_restart - reboot the system
*
* Shutdown everything and perform a clean reboot.
* This is not safe to call in interrupt context.
*/
void kernel_restart_prepare(char *cmd) void kernel_restart_prepare(char *cmd)
{ {
notifier_call_chain(&reboot_notifier_list, SYS_RESTART, cmd); notifier_call_chain(&reboot_notifier_list, SYS_RESTART, cmd);
system_state = SYSTEM_RESTART; system_state = SYSTEM_RESTART;
device_shutdown(); device_shutdown();
} }
/**
* kernel_restart - reboot the system
* @cmd: pointer to buffer containing command to execute for restart
* or NULL
*
* Shutdown everything and perform a clean reboot.
* This is not safe to call in interrupt context.
*/
void kernel_restart(char *cmd) void kernel_restart(char *cmd)
{ {
kernel_restart_prepare(cmd); kernel_restart_prepare(cmd);

View file

@ -1997,6 +1997,7 @@ int proc_dointvec_jiffies(ctl_table *table, int write, struct file *filp,
* @filp: the file structure * @filp: the file structure
* @buffer: the user buffer * @buffer: the user buffer
* @lenp: the size of the user buffer * @lenp: the size of the user buffer
* @ppos: pointer to the file position
* *
* Reads/writes up to table->maxlen/sizeof(unsigned int) integer * Reads/writes up to table->maxlen/sizeof(unsigned int) integer
* values from/to the user buffer, treated as an ASCII string. * values from/to the user buffer, treated as an ASCII string.

View file

@ -3263,6 +3263,7 @@ static void drain_array_locked(kmem_cache_t *cachep,
/** /**
* cache_reap - Reclaim memory from caches. * cache_reap - Reclaim memory from caches.
* @unused: unused parameter
* *
* Called from workqueue/eventd every few seconds. * Called from workqueue/eventd every few seconds.
* Purpose: * Purpose: