Commit b8887e6e8c04bcefb512cdb08fc7e9c310ac847e
Committed by
Linus Torvalds
1 parent
1e5d533142
Exists in
master
and in
4 other branches
[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>
Showing 4 changed files with 4 additions and 5 deletions Side-by-side Diff
drivers/block/ll_rw_blk.c
fs/fs-writeback.c
| ... | ... | @@ -606,7 +606,7 @@ |
| 606 | 606 | * O_SYNC flag set, to flush dirty writes to disk. |
| 607 | 607 | * |
| 608 | 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 | 611 | * OSYNC_DATA: i_mapping's dirty data |
| 612 | 612 | * OSYNC_METADATA: the buffers at i_mapping->private_list |
| 613 | 613 | |
| ... | ... | @@ -672,8 +672,9 @@ |
| 672 | 672 | |
| 673 | 673 | /** |
| 674 | 674 | * writeback_in_progress: determine whether there is writeback in progress |
| 675 | - * against a backing device. | |
| 676 | 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 | 679 | int writeback_in_progress(struct backing_dev_info *bdi) |
| 679 | 680 | { |
include/linux/kernel.h
| ... | ... | @@ -266,7 +266,6 @@ |
| 266 | 266 | |
| 267 | 267 | /** |
| 268 | 268 | * container_of - cast a member of a structure out to the containing structure |
| 269 | - * | |
| 270 | 269 | * @ptr: the pointer to the member. |
| 271 | 270 | * @type: the type of the container struct this is embedded in. |
| 272 | 271 | * @member: the name of the member within the struct. |
kernel/sys.c
| ... | ... | @@ -386,7 +386,7 @@ |
| 386 | 386 | /** |
| 387 | 387 | * kernel_restart - reboot the system |
| 388 | 388 | * @cmd: pointer to buffer containing command to execute for restart |
| 389 | - * or NULL | |
| 389 | + * or %NULL | |
| 390 | 390 | * |
| 391 | 391 | * Shutdown everything and perform a clean reboot. |
| 392 | 392 | * This is not safe to call in interrupt context. |