lkml.org 
[lkml]   [2005]   [Oct]   [25]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subject[PATCH] kernel-docs: fix kernel-doc format problems
From: Randy Dunlap <rdunlap@xenotime.net>

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>
---

drivers/block/ll_rw_blk.c | 1 -
fs/fs-writeback.c | 5 +++--
include/linux/kernel.h | 1 -
kernel/sys.c | 2 +-
4 files changed, 4 insertions(+), 5 deletions(-)

diff -Naurp linux-2614-rc5/drivers/block/ll_rw_blk.c~kdoc_no_blank_lines linux-2614-rc5/drivers/block/ll_rw_blk.c
--- linux-2614-rc5/drivers/block/ll_rw_blk.c~kdoc_no_blank_lines 2005-10-20 18:55:31.000000000 -0700
+++ linux-2614-rc5/drivers/block/ll_rw_blk.c 2005-10-23 12:17:01.000000000 -0700
@@ -706,7 +706,6 @@ EXPORT_SYMBOL(blk_queue_dma_alignment);

/**
* 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
*
diff -Naurp linux-2614-rc5/fs/fs-writeback.c~kdoc_no_blank_lines linux-2614-rc5/fs/fs-writeback.c
--- linux-2614-rc5/fs/fs-writeback.c~kdoc_no_blank_lines 2005-10-23 12:20:00.000000000 -0700
+++ linux-2614-rc5/fs/fs-writeback.c 2005-10-24 21:32:55.000000000 -0700
@@ -602,7 +602,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
- * written and waited upon:
+ * written and waited upon.
*
* OSYNC_DATA: i_mapping's dirty data
* OSYNC_METADATA: the buffers at i_mapping->private_list
@@ -668,8 +668,9 @@ int writeback_acquire(struct backing_dev

/**
* writeback_in_progress: determine whether there is writeback in progress
- * against a backing device.
* @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)
{
diff -Naurp linux-2614-rc5/include/linux/kernel.h~kdoc_no_blank_lines linux-2614-rc5/include/linux/kernel.h
--- linux-2614-rc5/include/linux/kernel.h~kdoc_no_blank_lines 2005-10-20 18:55:37.000000000 -0700
+++ linux-2614-rc5/include/linux/kernel.h 2005-10-23 12:11:34.000000000 -0700
@@ -266,7 +266,6 @@ extern void dump_stack(void);

/**
* 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.
diff -Naurp linux-2614-rc5/kernel/sys.c~kdoc_no_blank_lines linux-2614-rc5/kernel/sys.c
--- linux-2614-rc5/kernel/sys.c~kdoc_no_blank_lines 2005-10-23 10:28:34.000000000 -0700
+++ linux-2614-rc5/kernel/sys.c 2005-10-23 14:47:14.000000000 -0700
@@ -385,7 +385,7 @@ void kernel_restart_prepare(char *cmd)
/**
* 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.

---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
\
 
 \ /
  Last update: 2005-10-25 07:23    [W:0.025 / U:0.400 seconds]
©2003-2017 Jasper Spaans. hosted at Digital OceanAdvertise on this site