Re: [PATCH 03/15] leds: led-class: Fix incorrectly documented param 'dev'

Lee Jones
2021-06-01T09:06:01Z

On Fri, 28 May 2021, Alexander Dahl wrote:

> Hello,
>
> Am Fri, May 28, 2021 at 10:06:17AM +0100 schrieb Lee Jones:
> > Fixes the following W=1 kernel build warning(s):
> >
> > drivers/leds/led-class.c:521: warning: Function parameter or member 'dev' not described in 'devm_led_classdev_unregister'
> > drivers/leds/led-class.c:521: warning: Excess function parameter 'parent' description in 'devm_led_classdev_unregister'
> >
> > Cc: Pavel Machek <pavel@ucw.cz>
> > Cc: John Lenz <lenz@cs.wisc.edu>
> > Cc: Richard Purdie <rpurdie@openedhand.com>
> > Cc: linux-leds@vger.kernel.org
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
> > ---
> > drivers/leds/led-class.c | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/drivers/leds/led-class.c b/drivers/leds/led-class.c
> > index 2e495ff678562..16271a1de12a7 100644
> > --- a/drivers/leds/led-class.c
> > +++ b/drivers/leds/led-class.c
> > @@ -513,7 +513,7 @@ static int devm_led_classdev_match(struct device *dev, void *res, void *data)
> >
> > /**
> > * devm_led_classdev_unregister() - resource managed led_classdev_unregister()
> > - * @parent: The device to unregister.
> > + * @dev: The device to unregister.
> > * @led_cdev: the led_classdev structure for this device.
> > */
> > void devm_led_classdev_unregister(struct device *dev,
>
> Fixes: ca1bb4ee4c3a ("leds: Introduce devres helper for led_classdev_register")

Kernel-doc fix-ups do not qualify for Stable unfortunately.

> Reviewed-by: Alexander Dahl <ada@thorsis.com>

Thanks.

--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog