Commit 82f5b473 authored Jul 01, 2020 by Lee Jones Committed by Greg Kroah-Hartman Jul 01, 2020

misc: enclosure: Fix some kerneldoc anomalies

Firstly some missing function argument documentation, then some
whch are present, but are incorrectly named.

Fixes the following W=1 kernel build warnings:

drivers/misc/enclosure.c:115: warning: Function parameter or member 'name' not described in 'enclosure_register'
drivers/misc/enclosure.c:115: warning: Function parameter or member 'cb' not described in 'enclosure_register'
drivers/misc/enclosure.c:283: warning: Function parameter or member 'number' not described in 'enclosure_component_alloc'
drivers/misc/enclosure.c:283: warning: Excess function parameter 'num' description in 'enclosure_component_alloc'
drivers/misc/enclosure.c:363: warning: Function parameter or member 'component' not described in 'enclosure_add_device'
drivers/misc/enclosure.c:363: warning: Excess function parameter 'num' description in 'enclosure_add_device'
drivers/misc/enclosure.c:398: warning: Function parameter or member 'dev' not described in 'enclosure_remove_device'
drivers/misc/enclosure.c:398: warning: Excess function parameter 'num' description in 'enclosure_remove_device'

Cc: James Bottomley <James.Bottomley@HansenPartnership.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200701085853.164358-12-lee.jones@linaro.org

Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

parent 14395c6f

drivers/misc/enclosure.c

+4 −2

Original line number	Diff line number	Diff line
		@@ -103,7 +103,9 @@ EXPORT_SYMBOL_GPL(enclosure_for_each_device);
		* enclosure_register - register device as an enclosure
		*
		* @dev: device containing the enclosure
		* @name: chosen device name
		* @components: number of components in the enclosure
		* @cb: platform call-backs
		*
		* This sets up the device for being an enclosure. Note that @dev does
		* not have to be a dedicated enclosure device. It may be some other type
		@@ -266,7 +268,7 @@ static const struct attribute_group *enclosure_component_groups[];
		/**
		* enclosure_component_alloc - prepare a new enclosure component
		* @edev: the enclosure to add the component
		* @num: the device number
		* @number: the device number
		* @type: the type of component being added
		* @name: an optional name to appear in sysfs (leave NULL if none)
		*
		@@ -347,7 +349,7 @@ EXPORT_SYMBOL_GPL(enclosure_component_register);
		/**
		* enclosure_add_device - add a device as being part of an enclosure
		* @edev: the enclosure device being added to.
		* @num: the number of the component
		* @component: the number of the component
		* @dev: the device being added
		*
		* Declares a real device to reside in slot (or identifier) @num of an