* [PATCH] block: remove typo in kernel-doc of set_disk_ro()
@ 2021-01-29 4:55 Lukas Bulwahn
2021-01-29 5:12 ` Christoph Hellwig
0 siblings, 1 reply; 2+ messages in thread
From: Lukas Bulwahn @ 2021-01-29 4:55 UTC (permalink / raw)
To: Jens Axboe, linux-block
Cc: Christoph Hellwig, Jonathan Corbet, Mauro Carvalho Chehab,
linux-doc, kernel-janitors, linux-kernel, Lukas Bulwahn
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(-)
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
--
2.17.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] block: remove typo in kernel-doc of set_disk_ro()
2021-01-29 4:55 [PATCH] block: remove typo in kernel-doc of set_disk_ro() Lukas Bulwahn
@ 2021-01-29 5:12 ` Christoph Hellwig
0 siblings, 0 replies; 2+ messages in thread
From: Christoph Hellwig @ 2021-01-29 5:12 UTC (permalink / raw)
To: Lukas Bulwahn
Cc: Jens Axboe, linux-block, Christoph Hellwig, Jonathan Corbet,
Mauro Carvalho Chehab, linux-doc, kernel-janitors, linux-kernel
Looks good,
Reviewed-by: Christoph Hellwig <hch@lst.de>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-01-29 5:13 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-01-29 4:55 [PATCH] block: remove typo in kernel-doc of set_disk_ro() Lukas Bulwahn
2021-01-29 5:12 ` Christoph Hellwig
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox