block: fix current kernel-doc warnings

PATCH Applied Randy Dunlap 2 participants 2 messages Oct 14, 2008 – Oct 16, 2008

Subsystems (2)

VFS Block layer

lore

Share & tools

lore

Randy Dunlap

author

2008-10-14 17:04 UTC #0 lore raw

PATCH 1/1 block: fix current kernel-doc warnings

From: Randy Dunlap <[email protected]>

Fix block kernel-doc warnings:

Warning(linux-2.6.27-git4//fs/block_dev.c:1272): No description found for parameter 'path' Warning(linux-2.6.27-git4//block/blk-core.c:1021): No description found for parameter 'cpu' Warning(linux-2.6.27-git4//block/blk-core.c:1021): No description found for parameter 'part' Warning(/var/linsrc/linux-2.6.27-git4//block/genhd.c:544): No description found for parameter 'partno'

Signed-off-by Randy Dunlap <[email protected]>

---
 block/blk-core.c |    5 +++--
 block/genhd.c    |    2 +-
 fs/block_dev.c   |    2 +-
 3 files changed, 5 insertions(+), 4 deletions(-)

block/blk-core.c +3 -2

@@ -1003,8 +1003,9 @@ static void part_round_stats_single(int 
 }
 
 /**
- * part_round_stats()	- Round off the performance stats on a struct
- * disk_stats.
+ * part_round_stats() - Round off the performance stats on a struct disk_stats.
+ * @cpu: cpu number for stats access
+ * @part: target partition
  *
  * The average IO queue length and utilisation statistics are maintained
  * by observing the current state of the queue length and the amount of

block/genhd.c +1 -1

@@ -535,7 +535,7 @@ void unlink_gendisk(struct gendisk *disk
 /**
  * get_gendisk - get partitioning information for a given device
  * @devt: device to get partitioning information for
- * @part: returned partition index
+ * @partno: returned partition index
  *
  * This function gets the structure containing partitioning
  * information for the given device @devt.

fs/block_dev.c +1 -1

@@ -1262,7 +1262,7 @@ EXPORT_SYMBOL(ioctl_by_bdev);
 
 /**
  * lookup_bdev  - lookup a struct block_device by name
- * @pathname:	special file representing the block device
+ * @path:	special file representing the block device
  *
  * Get a reference to the blockdevice at @pathname in the current
  * namespace if possible and return it.  Return ERR_PTR(error)

Jens Axboe

Applied

2008-10-16 05:47 UTC #1 lore raw

Quoted 8 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>
Fix block kernel-doc warnings:
Warning(linux-2.6.27-git4//fs/block_dev.c:1272): No description found for parameter 'path' Warning(linux-2.6.27-git4//block/blk-core.c:1021): No description found for parameter 'cpu' Warning(linux-2.6.27-git4//block/blk-core.c:1021): No description found for parameter 'part' Warning(/var/linsrc/linux-2.6.27-git4//block/genhd.c:544): No description found for parameter 'partno'

Applied, thanks

Signature · 1 line

Jens Axboe