Commit 2e833c8c authored Nov 30, 2022 by Randy Dunlap Committed by Jens Axboe Dec 01, 2022

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



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>

parent 7a88b1a8

block/bdev.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -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 @@ 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().

kernel/trace/blktrace.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -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
		*
		**/