diff mbox series

[v1] gpiolib: acpi: Correct kernel doc of struct acpi_gpio_event

Message ID 20190125170302.65252-1-andriy.shevchenko@linux.intel.com
State New
Headers show
Series [v1] gpiolib: acpi: Correct kernel doc of struct acpi_gpio_event | expand

Commit Message

Andy Shevchenko Jan. 25, 2019, 5:03 p.m. UTC
The checker complains during build

gpiolib-acpi.c:45: warning: Function parameter or member 'irq_requested' not described in 'acpi_gpio_event'

because the typo in the field description.

Fix the name to have documentation up-to-date.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/gpio/gpiolib-acpi.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Mika Westerberg Jan. 27, 2019, 8:30 a.m. UTC | #1
On Fri, Jan 25, 2019 at 07:03:02PM +0200, Andy Shevchenko wrote:
> The checker complains during build
> 
> gpiolib-acpi.c:45: warning: Function parameter or member 'irq_requested' not described in 'acpi_gpio_event'
> 
> because the typo in the field description.
> 
> Fix the name to have documentation up-to-date.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Acked-by: Mika Westerberg <mika.westerberg@linux.intel.com>
Linus Walleij Jan. 28, 2019, 2:24 p.m. UTC | #2
On Fri, Jan 25, 2019 at 6:03 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:

> The checker complains during build
>
> gpiolib-acpi.c:45: warning: Function parameter or member 'irq_requested' not described in 'acpi_gpio_event'
>
> because the typo in the field description.
>
> Fix the name to have documentation up-to-date.
>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Patch applied with Mika's ACK.

Yours,
Linus Walleij
diff mbox series

Patch

diff --git a/drivers/gpio/gpiolib-acpi.c b/drivers/gpio/gpiolib-acpi.c
index d69997fd6d19..2513593f9800 100644
--- a/drivers/gpio/gpiolib-acpi.c
+++ b/drivers/gpio/gpiolib-acpi.c
@@ -29,7 +29,7 @@ 
  * @irq:	  Linux IRQ number for the event, for request_ / free_irq
  * @irqflags:     flags to pass to request_irq when requesting the IRQ
  * @irq_is_wake:  If the ACPI flags indicate the IRQ is a wakeup source
- * @is_requested: True if request_irq has been done
+ * @irq_requested:True if request_irq has been done
  * @desc:	  gpio_desc for the GPIO pin for this event
  */
 struct acpi_gpio_event {