Skip to contentSkip to conversation

block: fix the kerneldoc comment for __register_blkdev

PATCH Applied Christoph Hellwig 2 participants 2 messages Nov 14, 2020 Block layer

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 block: fix the kerneldoc comment for __register_blkdev

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")
---
 block/genhd.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
block/genhd.c +4 -1
index 15b90e56a1a6ea..e7b7cae30f7f85 100644
@@ -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))
Signature · 1 line
2.28.0
maintainer Applied
#1 lore raw
Quoted 2 lines · Christoph Hellwig

Switch the comment to talk about __register_blkdev instead of register_blkdev and document the new probe parameter.

Applied, thanks.

Signature · 1 line
Jens Axboe