Skip to contentSkip to conversation

block: add documentation for register_blkdev()

PATCH In review Németh Márton 2 participants 2 messages Feb 20, 2009 Block layer

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 block: add documentation for register_blkdev()

From: Márton Németh <[email protected]>

Add documentation for register_blkdev() function and for the parameters.

Cc Greg Kroah-Hartman <[email protected]>

---

block/genhd.c renamed from block/genhd.c.orig +16 -0
@@ -256,6 +256,22 @@ void blkdev_show(struct seq_file *seqf,
 }
 #endif /* CONFIG_PROC_FS */
 
+/**
+ * register_blkdev - register a new block device
+ *
+ * @major: the requested major device number [1..255]. If @major=0, try to
+ *         allocate any unused major number.
+ * @name: the name of the new block device as a zero terminated string
+ *
+ * The @name must be unique within the system.
+ *
+ * The return value depends on the @major input parameter.
+ *  - if a major device number was requested in range [1..255] then the
+ *    function returns zero on success, or a negative error code
+ *  - if any unused major number was requested with @major=0 parameter
+ *    then the return value is the allocated major number in range
+ *    [1..255] or a negative error code otherwise
+ */
 int register_blkdev(unsigned int major, const char *name)
 {
 	struct blk_major_name **n, *p;
#1 lore raw
Quoted 6 lines · Németh Márton

From: Márton Németh <[email protected]>

Add documentation for register_blkdev() function and for the parameters.

Cc Greg Kroah-Hartman <[email protected]>

Thanks Márton, applied.

Quoted 32 lines

---

block/genhd.c renamed from block/genhd.c.orig +16 -1
@@ -256,6 +256,22 @@ void blkdev_show(struct seq_file *seqf,
 }
 #endif /* CONFIG_PROC_FS */
 
+/**
+ * register_blkdev - register a new block device
+ *
+ * @major: the requested major device number [1..255]. If @major=0, try to
+ *         allocate any unused major number.
+ * @name: the name of the new block device as a zero terminated string
+ *
+ * The @name must be unique within the system.
+ *
+ * The return value depends on the @major input parameter.
+ *  - if a major device number was requested in range [1..255] then the
+ *    function returns zero on success, or a negative error code
+ *  - if any unused major number was requested with @major=0 parameter
+ *    then the return value is the allocated major number in range
+ *    [1..255] or a negative error code otherwise
+ */
 int register_blkdev(unsigned int major, const char *name)
 {
 	struct blk_major_name **n, *p;
--

To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

Signature · 1 line
Jens Axboe