Skip to content

Commit

Permalink
block: bdev & blktrace: use consistent function doc. notation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Randy Dunlap authored and Jens Axboe committed Dec 1, 2022
1 parent 7a88b1a commit 2e833c8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions block/bdev.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -268,7 +268,7 @@ int freeze_bdev(struct block_device *bdev)
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().
Expand Down
4 changes: 2 additions & 2 deletions kernel/trace/blktrace.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
*
**/
Expand Down

0 comments on commit 2e833c8

Please sign in to comment.