Messages in this thread | | | Date | Wed, 12 Jul 2006 08:53:19 -0700 | From | "Randy.Dunlap" <> | Subject | Re: [PATCH 1/2] add function documentation for register_chrdev() |
| |
On Wed, 12 Jul 2006 09:46:16 +0200 Rolf Eike Beer wrote:
> Documentation for register_chrdev() was missing completely.
I noticed that too.
Would you modify the patch to use the kernel-doc format, please?
See Documentation/kernel-doc-nano-HOWTO.txt or other source files for examples.
and "-ve" is overused/overrated. :) Please use "negative". (even though Andrew just used -ve yesterday)
> Signed-off-by: Rolf Eike Beer <eike-kernel@sf-tec.de> > > --- > 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) > {
--- ~Randy - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |