diff mbox series

block: fix the kerneldoc comment for __register_blkdev

Message ID 20201114170821.4714-1-hch@lst.de (mailing list archive)
State New, archived
Headers show
Series block: fix the kerneldoc comment for __register_blkdev | expand

Commit Message

Christoph Hellwig Nov. 14, 2020, 5:08 p.m. UTC 
Switch the comment to talk about __register_blkdev instead of
register_blkdev and document the new probe parameter.

Fixes: 3da1a61e7046 ("block: add an optional probe callback to major_names")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Christoph Hellwig <hch@lst.de>
---
 block/genhd.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Jens Axboe Nov. 14, 2020, 5:33 p.m. UTC | #1 
On 11/14/20 10:08 AM, Christoph Hellwig wrote:
> Switch the comment to talk about __register_blkdev instead of
> register_blkdev and document the new probe parameter.

Applied, thanks.
diff mbox series

Patch

diff --git a/block/genhd.c b/block/genhd.c
index 15b90e56a1a6ea..e7b7cae30f7f85 100644
--- a/block/genhd.c
+++ b/block/genhd.c
@@ -415,11 +415,12 @@  void blkdev_show(struct seq_file *seqf, off_t offset)
 #endif /* CONFIG_PROC_FS */
 
 /**
- * register_blkdev - register a new block device
+ * __register_blkdev - register a new block device
  *
  * @major: the requested major device number [1..BLKDEV_MAJOR_MAX-1]. If
  *         @major = 0, try to allocate any unused major number.
  * @name: the name of the new block device as a zero terminated string
+ * @probe: allback that is called on access to any minor number of @major
  *
  * The @name must be unique within the system.
  *
@@ -433,6 +434,8 @@  void blkdev_show(struct seq_file *seqf, off_t offset)
  *
  * See Documentation/admin-guide/devices.txt for the list of allocated
  * major numbers.
+ *
+ * Use register_blkdev instead for any new code.
  */
 int __register_blkdev(unsigned int major, const char *name,
 		void (*probe)(dev_t devt))