diff options
author | Randy Dunlap <rdunlap@xenotime.net> | 2005-11-07 04:01:07 -0500 |
---|---|---|
committer | Linus Torvalds <torvalds@g5.osdl.org> | 2005-11-07 10:53:55 -0500 |
commit | b8887e6e8c04bcefb512cdb08fc7e9c310ac847e (patch) | |
tree | f8dcfee2314ad0c1998e70449fdd814e675cf90a | |
parent | 1e5d533142c1c178a31d4cc81837eb078f9269bc (diff) |
[PATCH] kernel-docs: fix kernel-doc format problems
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>
-rw-r--r-- | drivers/block/ll_rw_blk.c | 1 | ||||
-rw-r--r-- | fs/fs-writeback.c | 5 | ||||
-rw-r--r-- | include/linux/kernel.h | 1 | ||||
-rw-r--r-- | kernel/sys.c | 2 |
4 files changed, 4 insertions, 5 deletions
diff --git a/drivers/block/ll_rw_blk.c b/drivers/block/ll_rw_blk.c index 2747741677fb..5f52e30b43f8 100644 --- a/drivers/block/ll_rw_blk.c +++ b/drivers/block/ll_rw_blk.c | |||
@@ -706,7 +706,6 @@ EXPORT_SYMBOL(blk_queue_dma_alignment); | |||
706 | 706 | ||
707 | /** | 707 | /** |
708 | * blk_queue_find_tag - find a request by its tag and queue | 708 | * blk_queue_find_tag - find a request by its tag and queue |
709 | * | ||
710 | * @q: The request queue for the device | 709 | * @q: The request queue for the device |
711 | * @tag: The tag of the request | 710 | * @tag: The tag of the request |
712 | * | 711 | * |
diff --git a/fs/fs-writeback.c b/fs/fs-writeback.c index 1361a4a64157..785c7213a54f 100644 --- a/fs/fs-writeback.c +++ b/fs/fs-writeback.c | |||
@@ -606,7 +606,7 @@ EXPORT_SYMBOL(sync_inode); | |||
606 | * O_SYNC flag set, to flush dirty writes to disk. | 606 | * O_SYNC flag set, to flush dirty writes to disk. |
607 | * | 607 | * |
608 | * @what is a bitmask, specifying which part of the inode's data should be | 608 | * @what is a bitmask, specifying which part of the inode's data should be |
609 | * written and waited upon: | 609 | * written and waited upon. |
610 | * | 610 | * |
611 | * OSYNC_DATA: i_mapping's dirty data | 611 | * OSYNC_DATA: i_mapping's dirty data |
612 | * OSYNC_METADATA: the buffers at i_mapping->private_list | 612 | * OSYNC_METADATA: the buffers at i_mapping->private_list |
@@ -672,8 +672,9 @@ int writeback_acquire(struct backing_dev_info *bdi) | |||
672 | 672 | ||
673 | /** | 673 | /** |
674 | * writeback_in_progress: determine whether there is writeback in progress | 674 | * writeback_in_progress: determine whether there is writeback in progress |
675 | * against a backing device. | ||
676 | * @bdi: the device's backing_dev_info structure. | 675 | * @bdi: the device's backing_dev_info structure. |
676 | * | ||
677 | * Determine whether there is writeback in progress against a backing device. | ||
677 | */ | 678 | */ |
678 | int writeback_in_progress(struct backing_dev_info *bdi) | 679 | int writeback_in_progress(struct backing_dev_info *bdi) |
679 | { | 680 | { |
diff --git a/include/linux/kernel.h b/include/linux/kernel.h index f1925ccc9fe1..b6419489b27b 100644 --- a/include/linux/kernel.h +++ b/include/linux/kernel.h | |||
@@ -266,7 +266,6 @@ extern void dump_stack(void); | |||
266 | 266 | ||
267 | /** | 267 | /** |
268 | * container_of - cast a member of a structure out to the containing structure | 268 | * container_of - cast a member of a structure out to the containing structure |
269 | * | ||
270 | * @ptr: the pointer to the member. | 269 | * @ptr: the pointer to the member. |
271 | * @type: the type of the container struct this is embedded in. | 270 | * @type: the type of the container struct this is embedded in. |
272 | * @member: the name of the member within the struct. | 271 | * @member: the name of the member within the struct. |
diff --git a/kernel/sys.c b/kernel/sys.c index 3e332131000e..bce933ebb29f 100644 --- a/kernel/sys.c +++ b/kernel/sys.c | |||
@@ -386,7 +386,7 @@ void kernel_restart_prepare(char *cmd) | |||
386 | /** | 386 | /** |
387 | * kernel_restart - reboot the system | 387 | * kernel_restart - reboot the system |
388 | * @cmd: pointer to buffer containing command to execute for restart | 388 | * @cmd: pointer to buffer containing command to execute for restart |
389 | * or NULL | 389 | * or %NULL |
390 | * | 390 | * |
391 | * Shutdown everything and perform a clean reboot. | 391 | * Shutdown everything and perform a clean reboot. |
392 | * This is not safe to call in interrupt context. | 392 | * This is not safe to call in interrupt context. |