linux-kernel - [PATCH] fs: block_dev.c: use consistent function doc. notation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20210102174814.10636-1-rdunlap@infradead.org>
Date:   Sat,  2 Jan 2021 09:48:14 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>, Jens Axboe <axboe@...nel.dk>,
        linux-block@...r.kernel.org
Subject: [PATCH] fs: block_dev.c: 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@...radead.org>
Cc: Jens Axboe <axboe@...nel.dk>
Cc: linux-block@...r.kernel.org
---
 fs/block_dev.c |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

--- lnx-511-rc1.orig/fs/block_dev.c
+++ lnx-511-rc1/fs/block_dev.c
@@ -533,7 +533,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
@@ -577,7 +577,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().
@@ -907,7 +907,7 @@ static struct block_device *bdget(dev_t
 }
 
 /**
- * bdgrab -- Grab a reference to an already referenced block device
+ * bdgrab - Grab a reference to an already referenced block device
  * @bdev:	Block device to grab a reference to.
  *
  * Returns the block_device with an additional reference when successful,