diff mbox series

block: bdev & blktrace: use consistent function doc. notation

Message ID 20221201070331.25685-1-rdunlap@infradead.org
State New
Headers
Series block: bdev & blktrace: use consistent function doc. notation |

Commit Message

Randy Dunlap Dec. 1, 2022, 7:03 a.m. UTC 
  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
---
 block/bdev.c            |    4 ++--
 kernel/trace/blktrace.c |    4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

Comments

Jens Axboe Dec. 1, 2022, 4:17 p.m. UTC | #1 
On Wed, 30 Nov 2022 23:03:31 -0800, Randy Dunlap wrote:
> 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.
> 
> 
> [...]

Applied, thanks!

[1/1] block: bdev & blktrace: use consistent function doc. notation
      commit: 2e833c8c8c42a3b6e22d6b3a9d2d18e425551261

Best regards,
diff mbox series

Patch

diff -- a/block/bdev.c b/block/bdev.c
--- a/block/bdev.c
+++ b/block/bdev.c
@@ -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().
diff -- a/kernel/trace/blktrace.c b/kernel/trace/blktrace.c
--- a/kernel/trace/blktrace.c
+++ b/kernel/trace/blktrace.c
@@ -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
 }
 
 /**
- * blk_trace_shutdown: - stop and cleanup trace structures
+ * blk_trace_shutdown - stop and cleanup trace structures
  * @q:    the request queue associated with the device
  *
  **/