Re: [PATCH] pinctrl: renesas: rza1: Fix kerneldoc function names

[Geert Uytterhoeven <geert@xxxxxxxxxxxxxx>]

Hi Jacopo,

On Tue, Oct 19, 2021 at 2:42 PM Jacopo Mondi <jacopo@xxxxxxxxxx> wrote:
> On Tue, Oct 19, 2021 at 02:34:22PM +0200, Geert Uytterhoeven wrote:
> > make W=1:
> >
> >     drivers/pinctrl/renesas/pinctrl-rza1.c:770: warning: expecting prototype for rza1_gpio_disable_free(). Prototype was for rza1_gpio_free() instead
> >     drivers/pinctrl/renesas/pinctrl-rza1.c:889: warning: expecting prototype for rza1_parse_pmx_function(). Prototype was for rza1_parse_pinmux_node() instead
> >
> > Fixes: 5a49b644b3075f88 ("pinctrl: Renesas RZ/A1 pin and gpio controller")
> > Signed-off-by: Geert Uytterhoeven <geert+renesas@xxxxxxxxx>
>
> Thanks, looking at the driver now it seems I was really eager to write
> comments at the time I wrote it! :)
>
> Probably all kernel-doc comments should be demoted to regular
> comments, as they're only internal driver functions.

;-)

> > --- a/drivers/pinctrl/renesas/pinctrl-rza1.c
> > +++ b/drivers/pinctrl/renesas/pinctrl-rza1.c
> > @@ -757,7 +757,7 @@ static int rza1_gpio_request(struct gpio_chip *chip, unsigned int gpio)
> >  }
> >
> >  /**
> > - * rza1_gpio_disable_free() - reset a pin
> > + * rza1_gpio_free() - reset a pin
> >   *
> >   * Surprisingly, disable_free a gpio, is equivalent to request it.
>
> s/disable_free/free ?

Yup, will fix while applying to:

    disabling a gpio is equivalent to requesting it

> Reviewed-by: Jacopo Mondi <jacopo+renesas@xxxxxxxxxx>

Thanks!

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@xxxxxxxxxxxxxx

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds