diff mbox series

block: remove typo in kernel-doc of set_disk_ro()

Message ID 20210129045505.22743-1-lukas.bulwahn@gmail.com (mailing list archive)
State New, archived
Headers show
Series block: remove typo in kernel-doc of set_disk_ro() | expand

Commit Message

Lukas Bulwahn Jan. 29, 2021, 4:55 a.m. UTC
Commit 52f019d43c22 ("block: add a hard-readonly flag to struct gendisk")
provides some kernel-doc for set_disk_ro(), but introduces a small typo.

Hence, make htmldocs warns on ./block/genhd.c:1441:

  warning: Function parameter or member 'read_only' not described in 'set_disk_ro'
  warning: Excess function parameter 'ready_only' description in 'set_disk_ro'

Remove that typo in the kernel-doc for set_disk_ro().

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
Jens, please pick this minor fix on your block-next tree.

 block/genhd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

hch@lst.de Jan. 29, 2021, 5:12 a.m. UTC | #1
Looks good,

Reviewed-by: Christoph Hellwig <hch@lst.de>
diff mbox series

Patch

diff --git a/block/genhd.c b/block/genhd.c
index d3ef29fbc536..304f8dcc9a9b 100644
--- a/block/genhd.c
+++ b/block/genhd.c
@@ -1431,7 +1431,7 @@  static void set_disk_ro_uevent(struct gendisk *gd, int ro)
 /**
  * set_disk_ro - set a gendisk read-only
  * @disk:	gendisk to operate on
- * @ready_only:	%true to set the disk read-only, %false set the disk read/write
+ * @read_only:	%true to set the disk read-only, %false set the disk read/write
  *
  * This function is used to indicate whether a given disk device should have its
  * read-only flag set. set_disk_ro() is typically used by device drivers to