block: bdev & blktrace: use consistent function doc. notation
authorRandy Dunlap <rdunlap@infradead.org>
Thu, 1 Dec 2022 07:03:31 +0000 (23:03 -0800)
committerJens Axboe <axboe@kernel.dk>
Thu, 1 Dec 2022 16:16:46 +0000 (09:16 -0700)
Use only one hyphen in kernel-doc notation between the function name
and its short description.

The is the documented kerenl-doc format. It also fixes the HTML
presentation to be consistent with other functions.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org
Link: https://lore.kernel.org/r/20221201070331.25685-1-rdunlap@infradead.org
Signed-off-by: Jens Axboe <axboe@kernel.dk>
block/bdev.c
kernel/trace/blktrace.c

index d699ecdb32604e7cb3f3ddcb9b71fa9762a3ba03..edc110d90df4041e7d337976951bd0d17525f1f7 100644 (file)
@@ -224,7 +224,7 @@ int fsync_bdev(struct block_device *bdev)
 EXPORT_SYMBOL(fsync_bdev);
 
 /**
- * freeze_bdev  --  lock a filesystem and force it into a consistent state
+ * freeze_bdev - lock a filesystem and force it into a consistent state
  * @bdev:      blockdevice to lock
  *
  * If a superblock is found on this device, we take the s_umount semaphore
@@ -268,7 +268,7 @@ done:
 EXPORT_SYMBOL(freeze_bdev);
 
 /**
- * thaw_bdev  -- unlock filesystem
+ * thaw_bdev - unlock filesystem
  * @bdev:      blockdevice to unlock
  *
  * Unlocks the filesystem and marks it writeable again after freeze_bdev().
index a995ea1ef849a4ef6b607c443b6a7bbdbbe548c5..94fde027bfc0cd4ed26949dd5c235a2f8b9084a6 100644 (file)
@@ -721,7 +721,7 @@ EXPORT_SYMBOL_GPL(blk_trace_startstop);
  */
 
 /**
- * blk_trace_ioctl: - handle the ioctls associated with tracing
+ * blk_trace_ioctl - handle the ioctls associated with tracing
  * @bdev:      the block device
  * @cmd:       the ioctl cmd
  * @arg:       the argument data, if any
@@ -769,7 +769,7 @@ int blk_trace_ioctl(struct block_device *bdev, unsigned cmd, char __user *arg)
 }
 
 /**
- * blk_trace_shutdown: - stop and cleanup trace structures
+ * blk_trace_shutdown - stop and cleanup trace structures
  * @q:    the request queue associated with the device
  *
  **/