[PATCH 1/2] add function documentation for register_chrdev()

[Rolf Eike Beer]

Documentation for register_chrdev() was missing completely.

Signed-off-by: Rolf Eike Beer <eike-kernel@xxxxxxxxx>

---
commit 7471539cb5e9cdd7ca7e48a247e15797d0e53708
tree 6ecd75500615ae9a975835596afb820b0fa51786
parent e73ad26773b26c730c49f8ef3b00b10b8bcc0009
author Rolf Eike Beer <eike-kernel@xxxxxxxxx> Tue, 11 Jul 2006 15:29:09 +0200
committer Rolf Eike Beer <beer@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx> Tue, 11 Jul 2006 15:29:09 +0200

 fs/char_dev.c |   23 +++++++++++++++++++++++
 1 files changed, 23 insertions(+), 0 deletions(-)

diff --git a/fs/char_dev.c b/fs/char_dev.c
index a4cbc67..ac28eaa 100644
--- a/fs/char_dev.c
+++ b/fs/char_dev.c
@@ -182,6 +182,29 @@ int alloc_chrdev_region(dev_t *dev, unsi
 	return 0;
 }
 
+/*
+ * Register a major number for character devices.
+ *
+ * major: major device number or 0 for dynamic allocation
+ * name: name of this range of devices
+ * fops: file operations associated with this devices
+ *
+ * If major == 0 this functions will dynamically allocate a major and return
+ * its number.
+ *
+ * If major > 0 this function will attempt to reserve a device with the given
+ * major number and will return zero on success.
+ *
+ * Returns a -ve errno on failure.
+ *
+ * The name of this device has nothing to do with the name of the device in
+ * /dev. It only helps to keep track of the different owners of devices. If
+ * your module name has only one type of devices it's ok to use e.g. the name
+ * of the module here.
+ *
+ * This function registers a range of 256 minor numbers. The first minor number
+ * is 0.
+ */
 int register_chrdev(unsigned int major, const char *name,
 		    const struct file_operations *fops)
 {
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/