[PATCH] gpio: fix kernel-doc notation warning for 'request_key'

[PATCH] gpio: fix kernel-doc notation warning for 'request_key'

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warning for missing struct member 'request_key':

../include/linux/gpio/driver.h:142: warning: Function parameter or member 'request_key' not described in 'gpio_irq_chip'

Fixes: 39c3fd58952d ("kernel/irq: Extend lockdep class for request mutex")

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Lunn <andrew@lunn.ch>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: linux-gpio@vger.kernel.org
---
 include/linux/gpio/driver.h |    8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

--- lnx-419-rc2.orig/include/linux/gpio/driver.h
+++ lnx-419-rc2/include/linux/gpio/driver.h
@@ -66,9 +66,15 @@ struct gpio_irq_chip {
 	/**
 	 * @lock_key:
 	 *
-	 * Per GPIO IRQ chip lockdep classes.
+	 * Per GPIO IRQ chip lockdep class for IRQ lock.
 	 */
 	struct lock_class_key *lock_key;
+
+	/**
+	 * @request_key:
+	 *
+	 * Per GPIO IRQ chip lockdep class for IRQ request.
+	 */
 	struct lock_class_key *request_key;
 
 	/**

Re: [PATCH] gpio: fix kernel-doc notation warning for 'request_key'

[Linus Walleij]

On Mon, Sep 3, 2018 at 9:55 PM Randy Dunlap <rdunlap@infradead.org> wrote:

> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix kernel-doc warning for missing struct member 'request_key':
>
> ../include/linux/gpio/driver.h:142: warning: Function parameter or member 'request_key' not described in 'gpio_irq_chip'
>
> Fixes: 39c3fd58952d ("kernel/irq: Extend lockdep class for request mutex")

Patch applied. Thanks for spending time with documentation!

Yours,
Linus Walleij