2020-06-15 06:52:41

by Mauro Carvalho Chehab

Subject: [PATCH 08/29] gpio: driver.h: fix kernel-doc markup

There is one parameter with a wrong name at kernel-doc macro:

./include/linux/gpio/driver.h:499: warning: Function parameter or member 'gc' not described in 'gpiochip_add_data'
./include/linux/gpio/driver.h:499: warning: Excess function parameter 'chip' description in 'gpiochip_add_data'

Fix it.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
include/linux/gpio/driver.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index c4f272af7af5..c11261f3c724 100644
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -481,7 +481,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,

/**
* gpiochip_add_data() - register a gpio_chip
- * @chip: the chip to register, with chip->base initialized
+ * @gc: the chip to register, with chip->base initialized
* @data: driver-private data associated with this chip
*
* Context: potentially before irqs will work
--
2.26.2

2020-06-15 08:08:32

by Bartosz Golaszewski

Subject: Re: [PATCH 08/29] gpio: driver.h: fix kernel-doc markup

pon., 15 cze 2020 o 08:47 Mauro Carvalho Chehab
<[email protected]> napisał(a):
>
> There is one parameter with a wrong name at kernel-doc macro:
>
> ./include/linux/gpio/driver.h:499: warning: Function parameter or member 'gc' not described in 'gpiochip_add_data'
> ./include/linux/gpio/driver.h:499: warning: Excess function parameter 'chip' description in 'gpiochip_add_data'
>
> Fix it.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> include/linux/gpio/driver.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
> index c4f272af7af5..c11261f3c724 100644
> --- a/include/linux/gpio/driver.h
> +++ b/include/linux/gpio/driver.h
> @@ -481,7 +481,7 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
>
> /**
> * gpiochip_add_data() - register a gpio_chip
> - * @chip: the chip to register, with chip->base initialized
> + * @gc: the chip to register, with chip->base initialized
> * @data: driver-private data associated with this chip
> *
> * Context: potentially before irqs will work
> --
> 2.26.2
>

Patch applied, thanks!

Bartosz