Linux-Block Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] fs: block_dev.c: use consistent function doc. notation
@ 2021-01-02 17:48 Randy Dunlap
  0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2021-01-02 17:48 UTC (permalink / raw)
  To: linux-kernel; +Cc: Randy Dunlap, Jens Axboe, linux-block

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
---
 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,

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, back to index

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-02 17:48 [PATCH] fs: block_dev.c: use consistent function doc. notation Randy Dunlap

Linux-Block Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-block/0 linux-block/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-block linux-block/ https://lore.kernel.org/linux-block \
		linux-block@vger.kernel.org
	public-inbox-index linux-block

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-block


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git