[PATCH] gpio: Timberdale: repair kernel-doc comments

Randy Dunlap posted 1 patch 1 month, 2 weeks ago
include/linux/timb_gpio.h |    6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
[PATCH] gpio: Timberdale: repair kernel-doc comments
Posted by Randy Dunlap 1 month, 2 weeks ago
Use a ':' after struct member names to avoid kernel-doc warnings:

Warning: include/linux/timb_gpio.h:22 struct member 'gpio_base' not
 described in 'timbgpio_platform_data'
Warning: include/linux/timb_gpio.h:22 struct member 'nr_pins' not
 described in 'timbgpio_platform_data'
Warning: include/linux/timb_gpio.h:22 struct member 'irq_base' not
 described in 'timbgpio_platform_data'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Linus Walleij <linusw@kernel.org>
Cc: Bartosz Golaszewski <brgl@kernel.org>
Cc: linux-gpio@vger.kernel.org

 include/linux/timb_gpio.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

--- linux-next-20260227.orig/include/linux/timb_gpio.h
+++ linux-next-20260227/include/linux/timb_gpio.h
@@ -9,10 +9,10 @@
 
 /**
  * struct timbgpio_platform_data - Platform data of the Timberdale GPIO driver
- * @gpio_base		The number of the first GPIO pin, set to -1 for
+ * @gpio_base:		The number of the first GPIO pin, set to -1 for
  *			dynamic number allocation.
- * @nr_pins		Number of pins that is supported by the hardware (1-32)
- * @irq_base		If IRQ is supported by the hardware, this is the base
+ * @nr_pins:		Number of pins that is supported by the hardware (1-32)
+ * @irq_base:		If IRQ is supported by the hardware, this is the base
  *			number of IRQ:s. One IRQ per pin will be used. Set to
  *			-1 if IRQ:s is not supported.
  */
Re: [PATCH] gpio: Timberdale: repair kernel-doc comments
Posted by Bartosz Golaszewski 1 month, 2 weeks ago
On Sat, 28 Feb 2026 17:48:22 -0800, Randy Dunlap wrote:
> Use a ':' after struct member names to avoid kernel-doc warnings:
> 
> Warning: include/linux/timb_gpio.h:22 struct member 'gpio_base' not
>  described in 'timbgpio_platform_data'
> Warning: include/linux/timb_gpio.h:22 struct member 'nr_pins' not
>  described in 'timbgpio_platform_data'
> Warning: include/linux/timb_gpio.h:22 struct member 'irq_base' not
>  described in 'timbgpio_platform_data'
> 
> [...]

Applied, thanks!

[1/1] gpio: Timberdale: repair kernel-doc comments
      https://git.kernel.org/brgl/c/8a9ebe8c3ca4c5bdad8f010656f4c2155da589fd

Best regards,
-- 
Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>