From mboxrd@z Thu Jan 1 00:00:00 1970 From: Henne Date: Tue, 04 Jul 2006 22:53:19 +0000 Subject: Re: [KJ] [PATCH] kernel-doc in drivers/base/core.c corrections Message-Id: <44AAF15F.2030208@nachtwindheim.de> List-Id: References: <44AA5740.8050906@nachtwindheim.de> In-Reply-To: <44AA5740.8050906@nachtwindheim.de> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: kernel-janitors@vger.kernel.org From: Henrik Kretzschmar Corrects the kerneldocs for device_create() and device_destroy() with an eye on coding style, grammar and readability. Signed-off-by: Henrik Kretzschmar --- --- linux-2.6.17-git22/drivers/base/core.c 2006-07-04 11:12:06.000000000 +0200 +++ linux/drivers/base/core.c 2006-07-05 00:45:03.000000000 +0200 @@ -559,20 +559,20 @@ /** * device_create - creates a device and registers it with sysfs - * @cs: pointer to the struct class that this device should be registered to. - * @parent: pointer to the parent struct device of this new device, if any. - * @dev: the dev_t for the char device to be added. - * @fmt: string for the class device's name + * @class: pointer to the struct class that this device should be registered to + * @parent: pointer to the parent struct device of this new device, if any + * @devt: the dev_t for the char device to be added + * @fmt: string for the device's name * - * This function can be used by char device classes. A struct - * device will be created in sysfs, registered to the specified - * class. + * This function can be used by char device classes. A struct device + * will be created in sysfs, registered to the specified class. + * * A "dev" file will be created, showing the dev_t for the device, if * the dev_t is not 0,0. - * If a pointer to a parent struct device is passed in, the newly - * created struct device will be a child of that device in sysfs. The - * pointer to the struct device will be returned from the call. Any - * further sysfs files that might be required can be created using this + * If a pointer to a parent struct device is passed in, the newly created + * struct device will be a child of that device in sysfs. + * The pointer to the struct device will be returned from the call. + * Any further sysfs files that might be required can be created using this * pointer. * * Note: the struct class passed to this function must have previously @@ -620,11 +620,11 @@ /** * device_destroy - removes a device that was created with device_create() - * @class: the pointer to the struct class that this device was registered * with. - * @dev: the dev_t of the device that was previously registered. + * @class: pointer to the struct class that this device was registered with + * @devt: the dev_t of the device that was previously registered * - * This call unregisters and cleans up a class device that was created with a - * call to class_device_create() + * This call unregisters and cleans up a device that was created with a + * call to device_create(). */ void device_destroy(struct class *class, dev_t devt) { _______________________________________________ Kernel-janitors mailing list Kernel-janitors@lists.osdl.org https://lists.osdl.org/mailman/listinfo/kernel-janitors