diff mbox series

gpio: fix kernel-doc for of_gpio_need_valid_mask()

Message ID 6c5d22c8-6e27-3314-9c46-701d932b11a6@infradead.org
State New
Headers show
Series gpio: fix kernel-doc for of_gpio_need_valid_mask() | expand

Commit Message

Randy Dunlap Oct. 8, 2019, 8:40 p.m. UTC 
From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc for of_gpio_need_valid_mask().
Fixes this warning and uses correct Return: format.

../drivers/gpio/gpiolib-of.c:92: warning: Excess function parameter 'dev' description in 'of_gpio_need_valid_mask'

Fixes: f626d6dfb709 ("gpio: of: Break out OF-only code")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Bartosz Golaszewski <bgolaszewski@baylibre.com>
Cc: linux-gpio@vger.kernel.org
---
 drivers/gpio/gpiolib-of.c |    5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Linus Walleij Oct. 9, 2019, 8:07 a.m. UTC | #1 
On Tue, Oct 8, 2019 at 10:40 PM Randy Dunlap <rdunlap@infradead.org> wrote:

> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix kernel-doc for of_gpio_need_valid_mask().
> Fixes this warning and uses correct Return: format.
>
> ../drivers/gpio/gpiolib-of.c:92: warning: Excess function parameter 'dev' description in 'of_gpio_need_valid_mask'
>
> Fixes: f626d6dfb709 ("gpio: of: Break out OF-only code")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Linus Walleij <linus.walleij@linaro.org>
> Cc: Bartosz Golaszewski <bgolaszewski@baylibre.com>
> Cc: linux-gpio@vger.kernel.org

Patch applied.

Yours,
Linus Walleij
diff mbox series

Patch

--- linux-next-20191008.orig/drivers/gpio/gpiolib-of.c
+++ linux-next-20191008/drivers/gpio/gpiolib-of.c
@@ -84,8 +84,9 @@  static struct gpio_desc *of_xlate_and_ge
 /**
  * of_gpio_need_valid_mask() - figure out if the OF GPIO driver needs
  * to set the .valid_mask
- * @dev: the device for the GPIO provider
- * @return: true if the valid mask needs to be set
+ * @gc: the target gpio_chip
+ *
+ * Return: true if the valid mask needs to be set
  */
 bool of_gpio_need_valid_mask(const struct gpio_chip *gc)
 {