[PATCH] Numerous fixes to kernel-doc info in source files.

A variety of (mostly) innocuous fixes to the embedded kernel-doc content in source files, including: * make multi-line initial descriptions single line * denote some function names, constants and structs as such * change erroneous opening '/*' to '/**' in a few places * reword some text for clarity Signed-off-by: Robert P. J. Day <rpjday@mindspring.com> Cc: "Randy.Dunlap" <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

[PATCH] Numerous fixes to kernel-doc info in source files.
A variety of (mostly) innocuous fixes to the embedded kernel-doc content in source files, including: * make multi-line initial descriptions single line * denote some function names, constants and structs as such * change erroneous opening '/*' to '/**' in a few places * reword some text for clarity Signed-off-by: Robert P. J. Day <rpjday@mindspring.com> Cc: "Randy.Dunlap" <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Robert P. J. Day · Linus Torvalds
1 parent 262086cf5b
Showing 33 changed files with 105 additions and 116 deletions Side-by-side Diff
include/asm-i386/atomic.h
include/asm-i386/bitops.h
include/linux/init.h
include/linux/kfifo.h
include/linux/ktime.h
include/linux/list.h
ipc/util.c
kernel/exit.c
kernel/hrtimer.c
kernel/kfifo.c
kernel/kthread.c
kernel/printk.c
kernel/relay.c
kernel/sched.c
kernel/signal.c
kernel/sys.c
kernel/timer.c
kernel/workqueue.c
lib/bitmap.c
lib/cmdline.c
@@ -211,12 +211,12 @@
 #define atomic_xchg(v, new) (xchg(&((v)->counter), new))
  
 /**
- * atomic_add_unless - add unless the number is a given value
+ * atomic_add_unless - add unless the number is already a given value
  * @v: pointer of type atomic_t
  * @a: the amount to add to v...
  * @u: ...unless v is equal to u.
  *
- * Atomically adds @a to @v, so long as it was not @u.
+ * Atomically adds @a to @v, so long as @v was not already @u.
  * Returns non-zero if @v was not @u, and zero otherwise.
  */
 #define atomic_add_unless(v, a, u)				\
@@ -371,7 +371,7 @@
  *
  * This is defined the same way as
  * the libc and compiler builtin ffs routines, therefore
- * differs in spirit from the above ffz (man ffs).
+ * differs in spirit from the above ffz() (man ffs).
  */
 static inline int ffs(int x)
 {
@@ -388,7 +388,7 @@
  * fls - find last bit set
  * @x: the word to search
  *
- * This is defined the same way as ffs.
+ * This is defined the same way as ffs().
  */
 static inline int fls(int x)
 {
@@ -172,7 +172,7 @@
  * module_init() - driver initialization entry point
  * @x: function to be run at kernel boot time or module insertion
  * 
- * module_init() will either be called during do_initcalls (if
+ * module_init() will either be called during do_initcalls() (if
  * builtin) or at module insertion time (if a module).  There can only
  * be one per module.
  */
@@ -74,7 +74,7 @@
  * @buffer: the data to be added.
  * @len: the length of the data to be added.
  *
- * This function copies at most 'len' bytes from the 'buffer' into
+ * This function copies at most @len bytes from the @buffer into
  * the FIFO depending on the free space, and returns the number of
  * bytes copied.
  */
@@ -99,8 +99,8 @@
  * @buffer: where the data must be copied.
  * @len: the size of the destination buffer.
  *
- * This function copies at most 'len' bytes from the FIFO into the
- * 'buffer' and returns the number of copied bytes.
+ * This function copies at most @len bytes from the FIFO into the
+ * @buffer and returns the number of copied bytes.
  */
 static inline unsigned int kfifo_get(struct kfifo *fifo,
 				     unsigned char *buffer, unsigned int len)
@@ -163,7 +163,7 @@
  * @add1:	addend1
  * @add2:	addend2
  *
- * Returns the sum of addend1 and addend2
+ * Returns the sum of @add1 and @add2.
  */
 static inline ktime_t ktime_add(const ktime_t add1, const ktime_t add2)
 {
@@ -189,7 +189,7 @@
  * @kt:		addend
  * @nsec:	the scalar nsec value to add
  *
- * Returns the sum of kt and nsec in ktime_t format
+ * Returns the sum of @kt and @nsec in ktime_t format
  */
 extern ktime_t ktime_add_ns(const ktime_t kt, u64 nsec);
  
@@ -246,7 +246,7 @@
  * ktime_to_ns - convert a ktime_t variable to scalar nanoseconds
  * @kt:		the ktime_t variable to convert
  *
- * Returns the scalar nanoseconds representation of kt
+ * Returns the scalar nanoseconds representation of @kt
  */
 static inline s64 ktime_to_ns(const ktime_t kt)
 {
@@ -161,7 +161,7 @@
 /**
  * list_del - deletes entry from list.
  * @entry: the element to delete from the list.
- * Note: list_empty on entry does not return true after this, the entry is
+ * Note: list_empty() on entry does not return true after this, the entry is
  * in an undefined state.
  */
 #ifndef CONFIG_DEBUG_LIST
@@ -179,7 +179,7 @@
  * list_del_rcu - deletes entry from list without re-initialization
  * @entry: the element to delete from the list.
  *
- * Note: list_empty on entry does not return true after this,
+ * Note: list_empty() on entry does not return true after this,
  * the entry is in an undefined state. It is useful for RCU based
  * lockfree traversal.
  *
@@ -209,7 +209,8 @@
  * list_replace - replace old entry by new one
  * @old : the element to be replaced
  * @new : the new element to insert
- * Note: if 'old' was empty, it will be overwritten.
+ *
+ * If @old was empty, it will be overwritten.
  */
 static inline void list_replace(struct list_head *old,
 				struct list_head *new)
  
@@ -488,12 +489,12 @@
 	     pos = list_entry(pos->member.prev, typeof(*pos), member))
  
 /**
- * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue
+ * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
  * @pos:	the type * to use as a start point
  * @head:	the head of the list
  * @member:	the name of the list_struct within the struct.
  *
- * Prepares a pos entry for use as a start point in list_for_each_entry_continue.
+ * Prepares a pos entry for use as a start point in list_for_each_entry_continue().
  */
 #define list_prepare_entry(pos, head, member) \
 	((pos) ? : list_entry(head, typeof(*pos), member))
@@ -150,7 +150,7 @@
  *	ipc_init	-	initialise IPC subsystem
  *
  *	The various system5 IPC resources (semaphores, messages and shared
- *	memory are initialised
+ *	memory) are initialised
  */
  
 static int __init ipc_init(void)
@@ -207,8 +207,7 @@
 #ifdef CONFIG_PROC_FS
 static struct file_operations sysvipc_proc_fops;
 /**
- *	ipc_init_proc_interface	-  Create a proc interface for sysipc types
- *				   using a seq_file interface.
+ *	ipc_init_proc_interface	-  Create a proc interface for sysipc types using a seq_file interface.
  *	@path: Path in procfs
  *	@header: Banner to be printed at the beginning of the file.
  *	@ids: ipc id table to iterate.
@@ -417,7 +416,7 @@
  *	@ptr: pointer returned by ipc_alloc
  *	@size: size of block
  *
- *	Free a block created with ipc_alloc. The caller must know the size
+ *	Free a block created with ipc_alloc(). The caller must know the size
  *	used in the allocation call.
  */
  
@@ -524,7 +523,7 @@
  * @head: RCU callback structure for queued work
  * 
  * 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().
  */
 static void ipc_schedule_free(struct rcu_head *head)
 {
@@ -541,7 +540,7 @@
  * 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)
 {
@@ -603,8 +602,8 @@
  *	@in: kernel permissions
  *	@out: new style IPC permissions
  *
- *	Turn the kernel object 'in' into a set of permissions descriptions
- *	for returning to userspace (out).
+ *	Turn the kernel object @in into a set of permissions descriptions
+ *	for returning to userspace (@out).
  */
  
  
@@ -624,8 +623,8 @@
  *	@in: new style IPC permissions
  *	@out: old style IPC permissions
  *
- *	Turn the new style permissions object in into a compatibility
- *	object and store it into the 'out' pointer.
+ *	Turn the new style permissions object @in into a compatibility
+ *	object and store it into the @out pointer.
  */
  
 void ipc64_perm_to_ipc_perm (struct ipc64_perm *in, struct ipc_perm *out)
@@ -722,7 +721,7 @@
  *	@cmd: pointer to command
  *
  *	Return IPC_64 for new style IPC and IPC_OLD for old style IPC. 
- *	The cmd value is turned from an encoding command and version into
+ *	The @cmd value is turned from an encoding command and version into
  *	just the command code.
  */
  
@@ -257,8 +257,7 @@
 }
  
 /**
- * reparent_to_init - Reparent the calling kernel thread to the init task
- * of the pid space that the thread belongs to.
+ * reparent_to_init - Reparent the calling kernel thread to the init task of the pid space that the thread belongs to.
  *
  * If a kernel thread is launched as a result of a system call, or if
  * it ever exits, it should generally reparent itself to init so that
@@ -102,7 +102,7 @@
  *
  * The function calculates the monotonic clock from the realtime
  * clock and the wall_to_monotonic offset and stores the result
- * in normalized timespec format in the variable pointed to by ts.
+ * in normalized timespec format in the variable pointed to by @ts.
  */
 void ktime_get_ts(struct timespec *ts)
 {
@@ -583,8 +583,8 @@
  * @which_clock: which clock to query
  * @tp:		 pointer to timespec variable to store the resolution
  *
- * Store the resolution of the clock selected by which_clock in the
- * variable pointed to by tp.
+ * Store the resolution of the clock selected by @which_clock in the
+ * variable pointed to by @tp.
  */
 int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp)
 {
@@ -32,8 +32,8 @@
  * @gfp_mask: get_free_pages mask, passed to kmalloc()
  * @lock: the lock to be used to protect the fifo buffer
  *
- * Do NOT pass the kfifo to kfifo_free() after use ! Simply free the
- * struct kfifo with kfree().
+ * Do NOT pass the kfifo to kfifo_free() after use! Simply free the
+ * &struct kfifo with kfree().
  */
 struct kfifo *kfifo_init(unsigned char *buffer, unsigned int size,
 			 gfp_t gfp_mask, spinlock_t *lock)
@@ -108,7 +108,7 @@
  * @buffer: the data to be added.
  * @len: the length of the data to be added.
  *
- * This function copies at most 'len' bytes from the 'buffer' into
+ * This function copies at most @len bytes from the @buffer into
  * the FIFO depending on the free space, and returns the number of
  * bytes copied.
  *
@@ -155,8 +155,8 @@
  * @buffer: where the data must be copied.
  * @len: the size of the destination buffer.
  *
- * This function copies at most 'len' bytes from the FIFO into the
- * 'buffer' and returns the number of copied bytes.
+ * This function copies at most @len bytes from the FIFO into the
+ * @buffer and returns the number of copied bytes.
  *
  * Note that with only one concurrent reader and one concurrent
  * writer, you don't need extra locking to use these functions.
@@ -50,7 +50,7 @@
 /**
  * kthread_should_stop - should this kthread return now?
  *
- * When someone calls kthread_stop on your kthread, it will be woken
+ * When someone calls kthread_stop() on your kthread, it will be woken
  * and this will return true.  You should then return, and your return
  * value will be passed through to kthread_stop().
  */
@@ -143,7 +143,7 @@
  * it.  See also kthread_run(), kthread_create_on_cpu().
  *
  * When woken, the thread will run @threadfn() with @data as its
- * argument. @threadfn can either call do_exit() directly if it is a
+ * argument. @threadfn() can either call do_exit() directly if it is a
  * standalone thread for which noone will call kthread_stop(), or
  * return when 'kthread_should_stop()' is true (which means
  * kthread_stop() has been called).  The return value should be zero
@@ -192,7 +192,7 @@
  *
  * Description: This function is equivalent to set_cpus_allowed(),
  * except that @cpu doesn't need to be online, and the thread must be
- * stopped (i.e., just returned from kthread_create().
+ * stopped (i.e., just returned from kthread_create()).
  */
 void kthread_bind(struct task_struct *k, unsigned int cpu)
 {
@@ -483,7 +483,7 @@
  * printk - print a kernel message
  * @fmt: format string
  *
- * This is printk.  It can be called from any context.  We want it to work.
+ * This is printk().  It can be called from any context.  We want it to work.
  *
  * We try to grab the console_sem.  If we succeed, it's easy - we log the output and
  * call the console drivers.  If we fail to get the semaphore we place the output
@@ -328,7 +328,7 @@
  *	@buf: the channel buffer
  *	@init: 1 if this is a first-time initialization
  *
- *	See relay_reset for description of effect.
+ *	See relay_reset() for description of effect.
  */
 static void __relay_reset(struct rchan_buf *buf, unsigned int init)
 {
@@ -364,7 +364,7 @@
  *	and restarting the channel in its initial state.  The buffers
  *	are not freed, so any mappings are still in effect.
  *
- *	NOTE: Care should be taken that the channel isn't actually
+ *	NOTE. Care should be taken that the channel isn't actually
  *	being used by anything when this call is made.
  */
 void relay_reset(struct rchan *chan)
@@ -528,7 +528,7 @@
  *	Creates a channel buffer for each cpu using the sizes and
  *	attributes specified.  The created channel buffer files
  *	will be named base_filename0...base_filenameN-1.  File
- *	permissions will be S_IRUSR.
+ *	permissions will be %S_IRUSR.
  */
 struct rchan *relay_open(const char *base_filename,
 			 struct dentry *parent,
@@ -648,7 +648,7 @@
  *	subbufs_consumed should be the number of sub-buffers newly consumed,
  *	not the total consumed.
  *
- *	NOTE: Kernel clients don't need to call this function if the channel
+ *	NOTE. Kernel clients don't need to call this function if the channel
  *	mode is 'overwrite'.
  */
 void relay_subbufs_consumed(struct rchan *chan,
@@ -749,7 +749,7 @@
  *	@filp: the file
  *	@vma: the vma describing what to map
  *
- *	Calls upon relay_mmap_buf to map the file into user space.
+ *	Calls upon relay_mmap_buf() to map the file into user space.
  */
 static int relay_file_mmap(struct file *filp, struct vm_area_struct *vma)
 {
@@ -891,7 +891,7 @@
  *	@read_pos: file read position
  *	@buf: relay channel buffer
  *
- *	If the read_pos is in the middle of padding, return the
+ *	If the @read_pos is in the middle of padding, return the
  *	position of the first actually available byte, otherwise
  *	return the original value.
  */
@@ -4203,13 +4203,12 @@
 }
  
 /**
- * sched_setscheduler - change the scheduling policy and/or RT priority of
- * a thread.
+ * sched_setscheduler - change the scheduling policy and/or RT priority of a thread.
  * @p: the task in question.
  * @policy: new policy.
  * @param: structure containing the new RT priority.
  *
- * NOTE: the task may be already dead
+ * NOTE that the task may be already dead.
  */
 int sched_setscheduler(struct task_struct *p, int policy,
 		       struct sched_param *param)
@@ -4577,7 +4576,7 @@
 /**
  * sys_sched_yield - yield the current processor to other threads.
  *
- * this function yields the current CPU by moving the calling thread
+ * This function yields the current CPU by moving the calling thread
  * to the expired array. If there are no other threads running on this
  * CPU then this function will return.
  */
@@ -4704,7 +4703,7 @@
 /**
  * yield - yield the current processor to other threads.
  *
- * this is a shortcut for kernel-space yielding - it marks the
+ * This is a shortcut for kernel-space yielding - it marks the
  * thread runnable and calls sys_sched_yield().
  */
 void __sched yield(void)
@@ -2282,7 +2282,7 @@
  *  @pid: the PID of the thread
  *  @sig: signal to be sent
  *
- *  This syscall also checks the tgid and returns -ESRCH even if the PID
+ *  This syscall also checks the @tgid and returns -ESRCH even if the PID
  *  exists but it's not belonging to the target process anymore. This
  *  method solves the problem of threads exiting and PIDs getting reused.
  */
@@ -215,7 +215,7 @@
  *	This routine uses RCU to synchronize with changes to the chain.
  *
  *	If the return value of the notifier can be and'ed
- *	with %NOTIFY_STOP_MASK then atomic_notifier_call_chain
+ *	with %NOTIFY_STOP_MASK then atomic_notifier_call_chain()
  *	will return immediately, with the return value of
  *	the notifier function which halted execution.
  *	Otherwise the return value is the return value
@@ -313,7 +313,7 @@
  *	run in a process context, so they are allowed to block.
  *
  *	If the return value of the notifier can be and'ed
- *	with %NOTIFY_STOP_MASK then blocking_notifier_call_chain
+ *	with %NOTIFY_STOP_MASK then blocking_notifier_call_chain()
  *	will return immediately, with the return value of
  *	the notifier function which halted execution.
  *	Otherwise the return value is the return value
@@ -393,7 +393,7 @@
  *	All locking must be provided by the caller.
  *
  *	If the return value of the notifier can be and'ed
- *	with %NOTIFY_STOP_MASK then raw_notifier_call_chain
+ *	with %NOTIFY_STOP_MASK then raw_notifier_call_chain()
  *	will return immediately, with the return value of
  *	the notifier function which halted execution.
  *	Otherwise the return value is the return value
@@ -487,7 +487,7 @@
  *	run in a process context, so they are allowed to block.
  *
  *	If the return value of the notifier can be and'ed
- *	with %NOTIFY_STOP_MASK then srcu_notifier_call_chain
+ *	with %NOTIFY_STOP_MASK then srcu_notifier_call_chain()
  *	will return immediately, with the return value of
  *	the notifier function which halted execution.
  *	Otherwise the return value is the return value
@@ -538,7 +538,7 @@
  *	Registers a function with the list of functions
  *	to be called at reboot time.
  *
- *	Currently always returns zero, as blocking_notifier_chain_register
+ *	Currently always returns zero, as blocking_notifier_chain_register()
  *	always returns zero.
  */
  
@@ -85,7 +85,7 @@
  * @j: the time in (absolute) jiffies that should be rounded
  * @cpu: the processor number on which the timeout will happen
  *
- * __round_jiffies rounds an absolute time in the future (in jiffies)
+ * __round_jiffies() rounds an absolute time in the future (in jiffies)
  * up or down to (approximately) full seconds. This is useful for timers
  * for which the exact time they fire does not matter too much, as long as
  * they fire approximately every X seconds.
@@ -98,7 +98,7 @@
  * processors firing at the exact same time, which could lead
  * to lock contention or spurious cache line bouncing.
  *
- * The return value is the rounded version of the "j" parameter.
+ * The return value is the rounded version of the @j parameter.
  */
 unsigned long __round_jiffies(unsigned long j, int cpu)
 {
@@ -142,7 +142,7 @@
  * @j: the time in (relative) jiffies that should be rounded
  * @cpu: the processor number on which the timeout will happen
  *
- * __round_jiffies_relative rounds a time delta  in the future (in jiffies)
+ * __round_jiffies_relative() rounds a time delta  in the future (in jiffies)
  * up or down to (approximately) full seconds. This is useful for timers
  * for which the exact time they fire does not matter too much, as long as
  * they fire approximately every X seconds.
@@ -155,7 +155,7 @@
  * processors firing at the exact same time, which could lead
  * to lock contention or spurious cache line bouncing.
  *
- * The return value is the rounded version of the "j" parameter.
+ * The return value is the rounded version of the @j parameter.
  */
 unsigned long __round_jiffies_relative(unsigned long j, int cpu)
 {
@@ -173,7 +173,7 @@
  * round_jiffies - function to round jiffies to a full second
  * @j: the time in (absolute) jiffies that should be rounded
  *
- * round_jiffies rounds an absolute time in the future (in jiffies)
+ * round_jiffies() rounds an absolute time in the future (in jiffies)
  * up or down to (approximately) full seconds. This is useful for timers
  * for which the exact time they fire does not matter too much, as long as
  * they fire approximately every X seconds.
@@ -182,7 +182,7 @@
  * at the same time, rather than at various times spread out. The goal
  * of this is to have the CPU wake up less, which saves power.
  *
- * The return value is the rounded version of the "j" parameter.
+ * The return value is the rounded version of the @j parameter.
  */
 unsigned long round_jiffies(unsigned long j)
 {
@@ -194,7 +194,7 @@
  * round_jiffies_relative - function to round jiffies to a full second
  * @j: the time in (relative) jiffies that should be rounded
  *
- * round_jiffies_relative rounds a time delta  in the future (in jiffies)
+ * round_jiffies_relative() rounds a time delta  in the future (in jiffies)
  * up or down to (approximately) full seconds. This is useful for timers
  * for which the exact time they fire does not matter too much, as long as
  * they fire approximately every X seconds.
@@ -203,7 +203,7 @@
  * at the same time, rather than at various times spread out. The goal
  * of this is to have the CPU wake up less, which saves power.
  *
- * The return value is the rounded version of the "j" parameter.
+ * The return value is the rounded version of the @j parameter.
  */
 unsigned long round_jiffies_relative(unsigned long j)
 {
@@ -387,7 +387,7 @@
  * @timer: the timer to be modified
  * @expires: new timeout in jiffies
  *
- * mod_timer is a more efficient way to update the expire field of an
+ * mod_timer() is a more efficient way to update the expire field of an
  * active timer (if the timer is inactive it will be activated)
  *
  * mod_timer(timer, expires) is equivalent to:
@@ -490,7 +490,7 @@
  * the timer it also makes sure the handler has finished executing on other
  * CPUs.
  *
- * Synchronization rules: callers must prevent restarting of the timer,
+ * Synchronization rules: Callers must prevent restarting of the timer,
  * otherwise this function is meaningless. It must not be called from
  * interrupt contexts. The caller must not hold locks which would prevent
  * completion of the timer's handler. The timer's handler must not call
@@ -656,8 +656,7 @@
 EXPORT_SYMBOL(flush_scheduled_work);
  
 /**
- * cancel_rearming_delayed_workqueue - reliably kill off a delayed
- *			work whose handler rearms the delayed work.
+ * cancel_rearming_delayed_workqueue - reliably kill off a delayed work whose handler rearms the delayed work.
  * @wq:   the controlling workqueue structure
  * @dwork: the delayed work struct
  */
@@ -670,8 +669,7 @@
 EXPORT_SYMBOL(cancel_rearming_delayed_workqueue);
  
 /**
- * cancel_rearming_delayed_work - reliably kill off a delayed keventd
- *			work whose handler rearms the delayed work.
+ * cancel_rearming_delayed_work - reliably kill off a delayed keventd work whose handler rearms the delayed work.
  * @dwork: the delayed work struct
  */
 void cancel_rearming_delayed_work(struct delayed_work *dwork)
@@ -95,7 +95,7 @@
 }
 EXPORT_SYMBOL(__bitmap_complement);
  
-/*
+/**
  * __bitmap_shift_right - logical right shift of the bits in a bitmap
  *   @dst - destination bitmap
  *   @src - source bitmap
@@ -139,7 +139,7 @@
 EXPORT_SYMBOL(__bitmap_shift_right);
  
  
-/*
+/**
  * __bitmap_shift_left - logical left shift of the bits in a bitmap
  *   @dst - destination bitmap
  *   @src - source bitmap
@@ -529,7 +529,7 @@
 }
 EXPORT_SYMBOL(bitmap_parselist);
  
-/*
+/**
  * bitmap_pos_to_ord(buf, pos, bits)
  *	@buf: pointer to a bitmap
  *	@pos: a bit position in @buf (0 <= @pos < @bits)
@@ -804,7 +804,7 @@
  *	@pos: beginning of bit region to release
  *	@order: region size (log base 2 of number of bits) to release
  *
- * This is the complement to __bitmap_find_free_region and releases
+ * This is the complement to __bitmap_find_free_region() and releases
  * the found region (by clearing it in the bitmap).
  *
  * No return value.
@@ -43,10 +43,10 @@
  *	comma as well.
  *
  *	Return values:
- *	0 : no int in string
- *	1 : int found, no subsequent comma
- *	2 : int found including a subsequent comma
- *	3 : hyphen found to denote a range
+ *	0 - no int in string
+ *	1 - int found, no subsequent comma
+ *	2 - int found including a subsequent comma
+ *	3 - hyphen found to denote a range
  */
  
 int get_option (char **str, int *pint)
@@ -329,8 +329,8 @@
  
 /**
  * idr_remove - remove the given id and free it's slot
- * idp: idr handle
- * id: uniqueue key
+ * @idp: idr handle
+ * @id: unique key
  */
 void idr_remove(struct idr *idp, int id)
 {
@@ -97,11 +97,12 @@
 }
  
 /**
- * kobject_get_path - generate and return the path associated with a given kobj
- * and kset pair.  The result must be freed by the caller with kfree().
+ * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
  *
  * @kobj:	kobject in question, with which to build the path
  * @gfp_mask:	the allocation type used to allocate the path
+ *
+ * The result must be freed by the caller with kfree().
  */
 char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
 {
@@ -20,8 +20,8 @@
 #define K3  0x8F1BBCDCL			/* Rounds 40-59: sqrt(5) * 2^30 */
 #define K4  0xCA62C1D6L			/* Rounds 60-79: sqrt(10) * 2^30 */
  
-/*
- * sha_transform: single block SHA1 transform
+/**
+ * sha_transform - single block SHA1 transform
  *
  * @digest: 160 bit digest to update
  * @data:   512 bits of data to hash
@@ -80,9 +80,8 @@
 }
 EXPORT_SYMBOL(sha_transform);
  
-/*
- * sha_init: initialize the vectors for a SHA1 digest
- *
+/**
+ * sha_init - initialize the vectors for a SHA1 digest
  * @buf: vector to initialize
  */
 void sha_init(__u32 *buf)
@@ -27,7 +27,7 @@
 	} while (--size > 0);
 }
  
-/*
+/**
  * sort - sort an array of elements
  * @base: pointer to data to sort
  * @num: number of elements
@@ -160,7 +160,7 @@
  * @src: The string to append to it
  * @count: The maximum numbers of bytes to copy
  *
- * Note that in contrast to strncpy, strncat ensures the result is
+ * Note that in contrast to strncpy(), strncat() ensures the result is
  * terminated.
  */
 char *strncat(char *dest, const char *src, size_t count)
@@ -366,8 +366,7 @@
  
 #ifndef __HAVE_ARCH_STRSPN
 /**
- * strspn - Calculate the length of the initial substring of @s which only
- * 	contain letters in @accept
+ * strspn - Calculate the length of the initial substring of @s which only contain letters in @accept
  * @s: The string to be searched
  * @accept: The string to search for
  */
@@ -394,8 +393,7 @@
  
 #ifndef __HAVE_ARCH_STRCSPN
 /**
- * strcspn - Calculate the length of the initial substring of @s which does
- * 	not contain letters in @reject
+ * strcspn - Calculate the length of the initial substring of @s which does not contain letters in @reject
  * @s: The string to be searched
  * @reject: The string to avoid
  */
@@ -218,7 +218,7 @@
  * Call textsearch_next() to retrieve subsequent matches.
  *
  * Returns the position of first occurrence of the pattern or
- * UINT_MAX if no occurrence was found.
+ * %UINT_MAX if no occurrence was found.
  */ 
 unsigned int textsearch_find_continuous(struct ts_config *conf,
 					struct ts_state *state,
@@ -247,12 +247,12 @@
  * be generated for the given input, excluding the trailing
  * '\0', as per ISO C99. If you want to have the exact
  * number of characters written into @buf as return value
- * (not including the trailing '\0'), use vscnprintf. If the
+ * (not including the trailing '\0'), use vscnprintf(). If the
  * return is greater than or equal to @size, the resulting
  * string is truncated.
  *
  * Call this function if you are already dealing with a va_list.
- * You probably want snprintf instead.
+ * You probably want snprintf() instead.
  */
 int vsnprintf(char *buf, size_t size, const char *fmt, va_list args)
 {
@@ -509,7 +509,7 @@
  * returns 0.
  *
  * Call this function if you are already dealing with a va_list.
- * You probably want scnprintf instead.
+ * You probably want scnprintf() instead.
  */
 int vscnprintf(char *buf, size_t size, const char *fmt, va_list args)
 {
  
@@ -577,11 +577,11 @@
  * @args: Arguments for the format string
  *
  * The function returns the number of characters written
- * into @buf. Use vsnprintf or vscnprintf in order to avoid
+ * into @buf. Use vsnprintf() or vscnprintf() in order to avoid
  * buffer overflows.
  *
  * Call this function if you are already dealing with a va_list.
- * You probably want sprintf instead.
+ * You probably want sprintf() instead.
  */
 int vsprintf(char *buf, const char *fmt, va_list args)
 {
@@ -597,7 +597,7 @@
  * @...: Arguments for the format string
  *
  * The function returns the number of characters written
- * into @buf. Use snprintf or scnprintf in order to avoid
+ * into @buf. Use snprintf() or scnprintf() in order to avoid
  * buffer overflows.
  */
 int sprintf(char * buf, const char *fmt, ...)
@@ -327,7 +327,7 @@
  * @pos:	beginning offset in pages to write
  * @count:	number of bytes to write
  *
- * Note: Holding i_mutex across sync_page_range_nolock is not a good idea
+ * Note: Holding i_mutex across sync_page_range_nolock() is not a good idea
  * as it forces O_SYNC writers to different parts of the same file
  * to be serialised right until io completion.
  */
@@ -784,7 +784,7 @@
  * @mapping: target address_space
  * @index: the page index
  *
- * Same as grab_cache_page, but do not wait if the page is unavailable.
+ * Same as grab_cache_page(), but do not wait if the page is unavailable.
  * This is intended for speculative data generators, where the data can
  * be regenerated if the page couldn't be grabbed.  This routine should
  * be safe to call while holding the lock for another page.
@@ -1775,9 +1775,7 @@
 }
  
 /**
- * unmap_mapping_range - unmap the portion of all mmaps
- * in the specified address_space corresponding to the specified
- * page range in the underlying file.
+ * unmap_mapping_range - unmap the portion of all mmaps in the specified address_space corresponding to the specified page range in the underlying file.
  * @mapping: the address space containing mmaps to be unmapped.
  * @holebegin: byte in first page to unmap, relative to the start of
  * the underlying file.  This will be rounded down to a PAGE_SIZE
@@ -46,9 +46,9 @@
  * @pool_data: optional private data available to the user-defined functions.
  *
  * this function creates and allocates a guaranteed size, preallocated
- * memory pool. The pool can be used from the mempool_alloc and mempool_free
+ * memory pool. The pool can be used from the mempool_alloc() and mempool_free()
  * functions. This function might sleep. Both the alloc_fn() and the free_fn()
- * functions might sleep - as long as the mempool_alloc function is not called
+ * functions might sleep - as long as the mempool_alloc() function is not called
  * from IRQ contexts.
  */
 mempool_t *mempool_create(int min_nr, mempool_alloc_t *alloc_fn,
@@ -195,7 +195,7 @@
  *             mempool_create().
  * @gfp_mask:  the usual allocation bitmask.
  *
- * this function only sleeps if the alloc_fn function sleeps or
+ * this function only sleeps if the alloc_fn() function sleeps or
  * returns NULL. Note that due to preallocation, this function
  * *never* fails when called from process contexts. (it might
  * fail if called from an IRQ context.)
@@ -549,9 +549,7 @@
 }
  
 /**
- * generic_writepages - walk the list of dirty pages of the given
- *                      address space and writepage() all of them.
- *
+ * generic_writepages - walk the list of dirty pages of the given address space and writepage() all of them.
  * @mapping: address space structure to write
  * @wbc: subtract the number of written pages from *@wbc->nr_to_write
  *
@@ -698,7 +696,6 @@
  
 /**
  * write_one_page - write out a single page and optionally wait on I/O
- *
  * @page: the page to write
  * @wait: if true, wait on writeout
  *
@@ -2520,7 +2520,7 @@
  * kmem_cache_destroy - delete a cache
  * @cachep: the cache to destroy
  *
- * Remove a struct kmem_cache object from the slab cache.
+ * Remove a &struct kmem_cache object from the slab cache.
  *
  * It is expected this function will be called by a module when it is
  * unloaded.  This will remove the cache completely, and avoid a duplicate
@@ -699,7 +699,7 @@
  *	that it is big enough to cover the vma. Will return failure if
  *	that criteria isn't met.
  *
- *	Similar to remap_pfn_range (see mm/memory.c)
+ *	Similar to remap_pfn_range() (see mm/memory.c)
  */
 int remap_vmalloc_range(struct vm_area_struct *vma, void *addr,
 						unsigned long pgoff)
...	...	@@ -211,12 +211,12 @@
211	211	#define atomic_xchg(v, new) (xchg(&((v)->counter), new))
212	212
213	213	/**
214		- * atomic_add_unless - add unless the number is a given value
	214	+ * atomic_add_unless - add unless the number is already a given value
215	215	* @v: pointer of type atomic_t
216	216	* @a: the amount to add to v...
217	217	* @u: ...unless v is equal to u.
218	218	*
219		- * Atomically adds @a to @v, so long as it was not @u.
	219	+ * Atomically adds @a to @v, so long as @v was not already @u.
220	220	* Returns non-zero if @v was not @u, and zero otherwise.
221	221	*/
222	222	#define atomic_add_unless(v, a, u) \
...	...	@@ -371,7 +371,7 @@
371	371	*
372	372	* This is defined the same way as
373	373	* the libc and compiler builtin ffs routines, therefore
374		- * differs in spirit from the above ffz (man ffs).
	374	+ * differs in spirit from the above ffz() (man ffs).
375	375	*/
376	376	static inline int ffs(int x)
377	377	{
...	...	@@ -388,7 +388,7 @@
388	388	* fls - find last bit set
389	389	* @x: the word to search
390	390	*
391		- * This is defined the same way as ffs.
	391	+ * This is defined the same way as ffs().
392	392	*/
393	393	static inline int fls(int x)
394	394	{
...	...	@@ -172,7 +172,7 @@
172	172	* module_init() - driver initialization entry point
173	173	* @x: function to be run at kernel boot time or module insertion
174	174	*
175		- * module_init() will either be called during do_initcalls (if
	175	+ * module_init() will either be called during do_initcalls() (if
176	176	* builtin) or at module insertion time (if a module). There can only
177	177	* be one per module.
178	178	*/
...	...	@@ -74,7 +74,7 @@
74	74	* @buffer: the data to be added.
75	75	* @len: the length of the data to be added.
76	76	*
77		- * This function copies at most 'len' bytes from the 'buffer' into
	77	+ * This function copies at most @len bytes from the @buffer into
78	78	* the FIFO depending on the free space, and returns the number of
79	79	* bytes copied.
80	80	*/
...	...	@@ -99,8 +99,8 @@
99	99	* @buffer: where the data must be copied.
100	100	* @len: the size of the destination buffer.
101	101	*
102		- * This function copies at most 'len' bytes from the FIFO into the
103		- * 'buffer' and returns the number of copied bytes.
	102	+ * This function copies at most @len bytes from the FIFO into the
	103	+ * @buffer and returns the number of copied bytes.
104	104	*/
105	105	static inline unsigned int kfifo_get(struct kfifo *fifo,
106	106	unsigned char *buffer, unsigned int len)
...	...	@@ -163,7 +163,7 @@
163	163	* @add1: addend1
164	164	* @add2: addend2
165	165	*
166		- * Returns the sum of addend1 and addend2
	166	+ * Returns the sum of @add1 and @add2.
167	167	*/
168	168	static inline ktime_t ktime_add(const ktime_t add1, const ktime_t add2)
169	169	{
...	...	@@ -189,7 +189,7 @@
189	189	* @kt: addend
190	190	* @nsec: the scalar nsec value to add
191	191	*
192		- * Returns the sum of kt and nsec in ktime_t format
	192	+ * Returns the sum of @kt and @nsec in ktime_t format
193	193	*/
194	194	extern ktime_t ktime_add_ns(const ktime_t kt, u64 nsec);
195	195
...	...	@@ -246,7 +246,7 @@
246	246	* ktime_to_ns - convert a ktime_t variable to scalar nanoseconds
247	247	* @kt: the ktime_t variable to convert
248	248	*
249		- * Returns the scalar nanoseconds representation of kt
	249	+ * Returns the scalar nanoseconds representation of @kt
250	250	*/
251	251	static inline s64 ktime_to_ns(const ktime_t kt)
252	252	{
...	...	@@ -161,7 +161,7 @@
161	161	/**
162	162	* list_del - deletes entry from list.
163	163	* @entry: the element to delete from the list.
164		- * Note: list_empty on entry does not return true after this, the entry is
	164	+ * Note: list_empty() on entry does not return true after this, the entry is
165	165	* in an undefined state.
166	166	*/
167	167	#ifndef CONFIG_DEBUG_LIST
...	...	@@ -179,7 +179,7 @@
179	179	* list_del_rcu - deletes entry from list without re-initialization
180	180	* @entry: the element to delete from the list.
181	181	*
182		- * Note: list_empty on entry does not return true after this,
	182	+ * Note: list_empty() on entry does not return true after this,
183	183	* the entry is in an undefined state. It is useful for RCU based
184	184	* lockfree traversal.
185	185	*
...	...	@@ -209,7 +209,8 @@
209	209	* list_replace - replace old entry by new one
210	210	* @old : the element to be replaced
211	211	* @new : the new element to insert
212		- * Note: if 'old' was empty, it will be overwritten.
	212	+ *
	213	+ * If @old was empty, it will be overwritten.
213	214	*/
214	215	static inline void list_replace(struct list_head *old,
215	216	struct list_head *new)
216	217
...	...	@@ -488,12 +489,12 @@
488	489	pos = list_entry(pos->member.prev, typeof(*pos), member))
489	490
490	491	/**
491		- * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue
	492	+ * list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
492	493	* @pos: the type * to use as a start point
493	494	* @head: the head of the list
494	495	* @member: the name of the list_struct within the struct.
495	496	*
496		- * Prepares a pos entry for use as a start point in list_for_each_entry_continue.
	497	+ * Prepares a pos entry for use as a start point in list_for_each_entry_continue().
497	498	*/
498	499	#define list_prepare_entry(pos, head, member) \
499	500	((pos) ? : list_entry(head, typeof(*pos), member))
...	...	@@ -150,7 +150,7 @@
150	150	* ipc_init - initialise IPC subsystem
151	151	*
152	152	* The various system5 IPC resources (semaphores, messages and shared
153		- * memory are initialised
	153	+ * memory) are initialised
154	154	*/
155	155
156	156	static int __init ipc_init(void)
...	...	@@ -207,8 +207,7 @@
207	207	#ifdef CONFIG_PROC_FS
208	208	static struct file_operations sysvipc_proc_fops;
209	209	/**
210		- * ipc_init_proc_interface - Create a proc interface for sysipc types
211		- * using a seq_file interface.
	210	+ * ipc_init_proc_interface - Create a proc interface for sysipc types using a seq_file interface.
212	211	* @path: Path in procfs
213	212	* @header: Banner to be printed at the beginning of the file.
214	213	* @ids: ipc id table to iterate.
...	...	@@ -417,7 +416,7 @@
417	416	* @ptr: pointer returned by ipc_alloc
418	417	* @size: size of block
419	418	*
420		- * Free a block created with ipc_alloc. The caller must know the size
	419	+ * Free a block created with ipc_alloc(). The caller must know the size
421	420	* used in the allocation call.
422	421	*/
423	422
...	...	@@ -524,7 +523,7 @@
524	523	* @head: RCU callback structure for queued work
525	524	*
526	525	* Since RCU callback function is called in bh,
527		- * we need to defer the vfree to schedule_work
	526	+ * we need to defer the vfree to schedule_work().
528	527	*/
529	528	static void ipc_schedule_free(struct rcu_head *head)
530	529	{
...	...	@@ -541,7 +540,7 @@
541	540	* ipc_immediate_free - free ipc + rcu space
542	541	* @head: RCU callback structure that contains pointer to be freed
543	542	*
544		- * Free from the RCU callback context
	543	+ * Free from the RCU callback context.
545	544	*/
546	545	static void ipc_immediate_free(struct rcu_head *head)
547	546	{
...	...	@@ -603,8 +602,8 @@
603	602	* @in: kernel permissions
604	603	* @out: new style IPC permissions
605	604	*
606		- * Turn the kernel object 'in' into a set of permissions descriptions
607		- * for returning to userspace (out).
	605	+ * Turn the kernel object @in into a set of permissions descriptions
	606	+ * for returning to userspace (@out).
608	607	*/
609	608
610	609
...	...	@@ -624,8 +623,8 @@
624	623	* @in: new style IPC permissions
625	624	* @out: old style IPC permissions
626	625	*
627		- * Turn the new style permissions object in into a compatibility
628		- * object and store it into the 'out' pointer.
	626	+ * Turn the new style permissions object @in into a compatibility
	627	+ * object and store it into the @out pointer.
629	628	*/
630	629
631	630	void ipc64_perm_to_ipc_perm (struct ipc64_perm in, struct ipc_perm out)
...	...	@@ -722,7 +721,7 @@
722	721	* @cmd: pointer to command
723	722	*
724	723	* Return IPC_64 for new style IPC and IPC_OLD for old style IPC.
725		- * The cmd value is turned from an encoding command and version into
	724	+ * The @cmd value is turned from an encoding command and version into
726	725	* just the command code.
727	726	*/
728	727
...	...	@@ -257,8 +257,7 @@
257	257	}
258	258
259	259	/**
260		- * reparent_to_init - Reparent the calling kernel thread to the init task
261		- * of the pid space that the thread belongs to.
	260	+ * reparent_to_init - Reparent the calling kernel thread to the init task of the pid space that the thread belongs to.
262	261	*
263	262	* If a kernel thread is launched as a result of a system call, or if
264	263	* it ever exits, it should generally reparent itself to init so that
...	...	@@ -102,7 +102,7 @@
102	102	*
103	103	* The function calculates the monotonic clock from the realtime
104	104	* clock and the wall_to_monotonic offset and stores the result
105		- * in normalized timespec format in the variable pointed to by ts.
	105	+ * in normalized timespec format in the variable pointed to by @ts.
106	106	*/
107	107	void ktime_get_ts(struct timespec *ts)
108	108	{
...	...	@@ -583,8 +583,8 @@
583	583	* @which_clock: which clock to query
584	584	* @tp: pointer to timespec variable to store the resolution
585	585	*
586		- * Store the resolution of the clock selected by which_clock in the
587		- * variable pointed to by tp.
	586	+ * Store the resolution of the clock selected by @which_clock in the
	587	+ * variable pointed to by @tp.
588	588	*/
589	589	int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp)
590	590	{
...	...	@@ -32,8 +32,8 @@
32	32	* @gfp_mask: get_free_pages mask, passed to kmalloc()
33	33	* @lock: the lock to be used to protect the fifo buffer
34	34	*
35		- * Do NOT pass the kfifo to kfifo_free() after use ! Simply free the
36		- * struct kfifo with kfree().
	35	+ * Do NOT pass the kfifo to kfifo_free() after use! Simply free the
	36	+ * &struct kfifo with kfree().
37	37	*/
38	38	struct kfifo kfifo_init(unsigned char buffer, unsigned int size,
39	39	gfp_t gfp_mask, spinlock_t *lock)
...	...	@@ -108,7 +108,7 @@
108	108	* @buffer: the data to be added.
109	109	* @len: the length of the data to be added.
110	110	*
111		- * This function copies at most 'len' bytes from the 'buffer' into
	111	+ * This function copies at most @len bytes from the @buffer into
112	112	* the FIFO depending on the free space, and returns the number of
113	113	* bytes copied.
114	114	*
...	...	@@ -155,8 +155,8 @@
155	155	* @buffer: where the data must be copied.
156	156	* @len: the size of the destination buffer.
157	157	*
158		- * This function copies at most 'len' bytes from the FIFO into the
159		- * 'buffer' and returns the number of copied bytes.
	158	+ * This function copies at most @len bytes from the FIFO into the
	159	+ * @buffer and returns the number of copied bytes.
160	160	*
161	161	* Note that with only one concurrent reader and one concurrent
162	162	* writer, you don't need extra locking to use these functions.