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

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

[Geert Uytterhoeven]

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@glider.be>
---
To be queued in renesas-pinctrl for v5.17.

 drivers/pinctrl/renesas/pinctrl-rza1.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/pinctrl/renesas/pinctrl-rza1.c b/drivers/pinctrl/renesas/pinctrl-rza1.c
index 10020fe302b8a09f..3ad0537febe4f6b4 100644
--- 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.
  * Reset pin to port mode, with input buffer disabled. This overwrites all
@@ -875,7 +875,7 @@ static int rza1_dt_node_pin_count(struct device_node *np)
 }
 
 /**
- * rza1_parse_pmx_function() - parse a pin mux sub-node
+ * rza1_parse_pinmux_node() - parse a pin mux sub-node
  *
  * @rza1_pctl: RZ/A1 pin controller device
  * @np: of pmx sub-node
-- 
2.25.1

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

[Jacopo Mondi]

Hi Geert,

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@glider.be>

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.

But for now, the change is good

> ---
> To be queued in renesas-pinctrl for v5.17.
>
>  drivers/pinctrl/renesas/pinctrl-rza1.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/pinctrl/renesas/pinctrl-rza1.c b/drivers/pinctrl/renesas/pinctrl-rza1.c
> index 10020fe302b8a09f..3ad0537febe4f6b4 100644
> --- 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 ?

Reviewed-by: Jacopo Mondi <jacopo+renesas@jmondi.org>

Thanks
   j

>   * Reset pin to port mode, with input buffer disabled. This overwrites all
> @@ -875,7 +875,7 @@ static int rza1_dt_node_pin_count(struct device_node *np)
>  }
>
>  /**
> - * rza1_parse_pmx_function() - parse a pin mux sub-node
> + * rza1_parse_pinmux_node() - parse a pin mux sub-node
>   *
>   * @rza1_pctl: RZ/A1 pin controller device
>   * @np: of pmx sub-node
> --
> 2.25.1
>

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

[Geert Uytterhoeven]

Hi Jacopo,

On Tue, Oct 19, 2021 at 2:42 PM Jacopo Mondi <jacopo@jmondi.org> 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@glider.be>
>
> 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@jmondi.org>

Thanks!

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

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

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

[Geert Uytterhoeven]

On Tue, Oct 19, 2021 at 2:54 PM Geert Uytterhoeven <geert@linux-m68k.org> wrote:
> On Tue, Oct 19, 2021 at 2:42 PM Jacopo Mondi <jacopo@jmondi.org> wrote:
> > On Tue, Oct 19, 2021 at 02:34:22PM +0200, Geert Uytterhoeven wrote:
> > > --- 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

"freeing...", of course.

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

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