block: bdev & blktrace: use consistent function doc. notation
Subsystems (2)
PATCH 1/1 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.
--- block/bdev.c | 4 ++-- kernel/trace/blktrace.c | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-)
block/bdev.c +2 -2
@@ -224,7 +224,7 @@ int fsync_bdev(struct block_device *bdevEXPORT_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().
kernel/trace/blktrace.c +2 -2
@@ -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 * **/
Quoted 8 lines · Randy Dunlap
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,
Signature · 1 line
Jens Axboe