[PATCH] kernel-docs: fix kernel-doc format problems
authorRandy Dunlap <rdunlap@xenotime.net>
Mon, 7 Nov 2005 09:01:07 +0000 (01:01 -0800)
committerLinus Torvalds <torvalds@g5.osdl.org>
Mon, 7 Nov 2005 15:53:55 +0000 (07:53 -0800)
Convert to proper kernel-doc format.

Some have extra blank lines (not allowed immed.  after the function name)
or need blank lines (after all parameters).  Function summary must be only
one line.

Colon (":") in a function description does weird things (causes kernel-doc
to think that it's a new section head sadly).

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
drivers/block/ll_rw_blk.c
fs/fs-writeback.c
include/linux/kernel.h
kernel/sys.c

index 2747741677fb0d92c10dc76c272763eb6f2b1a96..5f52e30b43f812c75cef8289571e9a1a35bd2808 100644 (file)
@@ -706,7 +706,6 @@ EXPORT_SYMBOL(blk_queue_dma_alignment);
 
 /**
  * blk_queue_find_tag - find a request by its tag and queue
 
 /**
  * blk_queue_find_tag - find a request by its tag and queue
- *
  * @q:  The request queue for the device
  * @tag: The tag of the request
  *
  * @q:  The request queue for the device
  * @tag: The tag of the request
  *
index 1361a4a641571e891f2a13b38bcce7452367e156..785c7213a54f513186aa5e403a1a3066f646eb12 100644 (file)
@@ -606,7 +606,7 @@ EXPORT_SYMBOL(sync_inode);
  * O_SYNC flag set, to flush dirty writes to disk.
  *
  * @what is a bitmask, specifying which part of the inode's data should be
  * O_SYNC flag set, to flush dirty writes to disk.
  *
  * @what is a bitmask, specifying which part of the inode's data should be
- * written and waited upon:
+ * written and waited upon.
  *
  *    OSYNC_DATA:     i_mapping's dirty data
  *    OSYNC_METADATA: the buffers at i_mapping->private_list
  *
  *    OSYNC_DATA:     i_mapping's dirty data
  *    OSYNC_METADATA: the buffers at i_mapping->private_list
@@ -672,8 +672,9 @@ int writeback_acquire(struct backing_dev_info *bdi)
 
 /**
  * writeback_in_progress: determine whether there is writeback in progress
 
 /**
  * writeback_in_progress: determine whether there is writeback in progress
- *                        against a backing device.
  * @bdi: the device's backing_dev_info structure.
  * @bdi: the device's backing_dev_info structure.
+ *
+ * Determine whether there is writeback in progress against a backing device.
  */
 int writeback_in_progress(struct backing_dev_info *bdi)
 {
  */
 int writeback_in_progress(struct backing_dev_info *bdi)
 {
index f1925ccc9fe1696496cdad0f9f2bcf583bf2eb5c..b6419489b27b2b03bc2610c4a786ab9d1c10b14b 100644 (file)
@@ -266,7 +266,6 @@ extern void dump_stack(void);
 
 /**
  * container_of - cast a member of a structure out to the containing structure
 
 /**
  * container_of - cast a member of a structure out to the containing structure
- *
  * @ptr:       the pointer to the member.
  * @type:      the type of the container struct this is embedded in.
  * @member:    the name of the member within the struct.
  * @ptr:       the pointer to the member.
  * @type:      the type of the container struct this is embedded in.
  * @member:    the name of the member within the struct.
index 3e332131000ead377e3424306805f0fa57792fec..bce933ebb29f458908806101dae497332004b2e2 100644 (file)
@@ -386,7 +386,7 @@ void kernel_restart_prepare(char *cmd)
 /**
  *     kernel_restart - reboot the system
  *     @cmd: pointer to buffer containing command to execute for restart
 /**
  *     kernel_restart - reboot the system
  *     @cmd: pointer to buffer containing command to execute for restart
- *             or NULL
+ *             or %NULL
  *
  *     Shutdown everything and perform a clean reboot.
  *     This is not safe to call in interrupt context.
  *
  *     Shutdown everything and perform a clean reboot.
  *     This is not safe to call in interrupt context.