Linux-GPIO Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH] gpio: Correct kernel-doc inconsistency
@ 2020-07-19 21:09 Colton Lewis
  2020-07-21 13:03 ` Linus Walleij
  0 siblings, 1 reply; 5+ messages in thread
From: Colton Lewis @ 2020-07-19 21:09 UTC (permalink / raw)
  To: linus.walleij; +Cc: linux-gpio, Colton Lewis

Silence documentation build warnings by correcting kernel-doc comment
for gpiochip_add_data function.

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

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
 include/linux/gpio/driver.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index c4f272af7af5..ee5f86f67ef8 100644
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -481,25 +481,25 @@ 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 gc->base initialized
  * @data: driver-private data associated with this chip
  *
  * Context: potentially before irqs will work
  *
  * When gpiochip_add_data() is called very early during boot, so that GPIOs
- * can be freely used, the chip->parent device must be registered before
+ * can be freely used, the gc->parent device must be registered before
  * the gpio framework's arch_initcall().  Otherwise sysfs initialization
  * for GPIOs will fail rudely.
  *
  * gpiochip_add_data() must only be called after gpiolib initialization,
  * ie after core_initcall().
  *
- * If chip->base is negative, this requests dynamic assignment of
+ * If gc->base is negative, this requests dynamic assignment of
  * a range of valid GPIOs.
  *
  * Returns:
  * A negative errno if the chip can't be registered, such as because the
- * chip->base is invalid or already associated with a different chip.
+ * gc->base is invalid or already associated with a different chip.
  * Otherwise it returns zero as a success code.
  */
 #ifdef CONFIG_LOCKDEP
-- 
2.26.2



^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] gpio: Correct kernel-doc inconsistency
  2020-07-19 21:09 [PATCH] gpio: Correct kernel-doc inconsistency Colton Lewis
@ 2020-07-21 13:03 ` Linus Walleij
  2020-07-23  9:58   ` [PATCH v2] " Colton Lewis
  0 siblings, 1 reply; 5+ messages in thread
From: Linus Walleij @ 2020-07-21 13:03 UTC (permalink / raw)
  To: Colton Lewis; +Cc: open list:GPIO SUBSYSTEM

Hi Colton,

thanks for your patch!

On Sun, Jul 19, 2020 at 11:09 PM Colton Lewis
<colton.w.lewis@protonmail.com> wrote:

> Silence documentation build warnings by correcting kernel-doc comment
> for gpiochip_add_data function.
>
> ./include/linux/gpio/driver.h:512: warning: Function parameter or member 'gc' not described in 'gpiochip_add_data'
> ./include/linux/gpio/driver.h:512: warning: Excess function parameter 'chip' description in 'gpiochip_add_data'
>
> Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>

This does not apply to my current "devel" branch:
https://git.kernel.org/pub/scm/linux/kernel/git/linusw/linux-gpio.git/log/?h=devel

Could you rebase and respin?

Yours,
Linus Walleij

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [PATCH v2] gpio: Correct kernel-doc inconsistency
  2020-07-21 13:03 ` Linus Walleij
@ 2020-07-23  9:58   ` Colton Lewis
  2020-07-23 13:18     ` Linus Walleij
  0 siblings, 1 reply; 5+ messages in thread
From: Colton Lewis @ 2020-07-23  9:58 UTC (permalink / raw)
  To: linus.walleij; +Cc: linux-gpio, Colton Lewis

Fix kernel-doc comment to match parameter name change "chip" to "gc"
in gpiochip_add_data function.

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
 include/linux/gpio/driver.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index db82451776fc..6e9f1826ecd7 100644
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -497,25 +497,25 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
 
 /**
  * gpiochip_add_data() - register a gpio_chip
- * @gc: the chip to register, with chip->base initialized
+ * @gc: the chip to register, with gc->base initialized
  * @data: driver-private data associated with this chip
  *
  * Context: potentially before irqs will work
  *
  * When gpiochip_add_data() is called very early during boot, so that GPIOs
- * can be freely used, the chip->parent device must be registered before
+ * can be freely used, the gc->parent device must be registered before
  * the gpio framework's arch_initcall().  Otherwise sysfs initialization
  * for GPIOs will fail rudely.
  *
  * gpiochip_add_data() must only be called after gpiolib initialization,
  * ie after core_initcall().
  *
- * If chip->base is negative, this requests dynamic assignment of
+ * If gc->base is negative, this requests dynamic assignment of
  * a range of valid GPIOs.
  *
  * Returns:
  * A negative errno if the chip can't be registered, such as because the
- * chip->base is invalid or already associated with a different chip.
+ * gc->base is invalid or already associated with a different chip.
  * Otherwise it returns zero as a success code.
  */
 #ifdef CONFIG_LOCKDEP
-- 
2.26.2



^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH v2] gpio: Correct kernel-doc inconsistency
  2020-07-23  9:58   ` [PATCH v2] " Colton Lewis
@ 2020-07-23 13:18     ` Linus Walleij
  0 siblings, 0 replies; 5+ messages in thread
From: Linus Walleij @ 2020-07-23 13:18 UTC (permalink / raw)
  To: Colton Lewis; +Cc: open list:GPIO SUBSYSTEM

On Thu, Jul 23, 2020 at 11:58 AM Colton Lewis
<colton.w.lewis@protonmail.com> wrote:

> Fix kernel-doc comment to match parameter name change "chip" to "gc"
> in gpiochip_add_data function.
>
> Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>

Patch applied!

Yours,
Linus Walleij

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [PATCH] gpio: Correct kernel-doc inconsistency
@ 2020-07-19 21:08 Colton Lewis
  0 siblings, 0 replies; 5+ messages in thread
From: Colton Lewis @ 2020-07-19 21:08 UTC (permalink / raw)
  To: linux.walleij; +Cc: linux-gpio, Colton Lewis

Silence documentation build warnings by correcting kernel-doc comment
for gpiochip_add_data function.

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

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
 include/linux/gpio/driver.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index c4f272af7af5..ee5f86f67ef8 100644
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -481,25 +481,25 @@ 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 gc->base initialized
  * @data: driver-private data associated with this chip
  *
  * Context: potentially before irqs will work
  *
  * When gpiochip_add_data() is called very early during boot, so that GPIOs
- * can be freely used, the chip->parent device must be registered before
+ * can be freely used, the gc->parent device must be registered before
  * the gpio framework's arch_initcall().  Otherwise sysfs initialization
  * for GPIOs will fail rudely.
  *
  * gpiochip_add_data() must only be called after gpiolib initialization,
  * ie after core_initcall().
  *
- * If chip->base is negative, this requests dynamic assignment of
+ * If gc->base is negative, this requests dynamic assignment of
  * a range of valid GPIOs.
  *
  * Returns:
  * A negative errno if the chip can't be registered, such as because the
- * chip->base is invalid or already associated with a different chip.
+ * gc->base is invalid or already associated with a different chip.
  * Otherwise it returns zero as a success code.
  */
 #ifdef CONFIG_LOCKDEP
-- 
2.26.2



^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, back to index

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-19 21:09 [PATCH] gpio: Correct kernel-doc inconsistency Colton Lewis
2020-07-21 13:03 ` Linus Walleij
2020-07-23  9:58   ` [PATCH v2] " Colton Lewis
2020-07-23 13:18     ` Linus Walleij
  -- strict thread matches above, loose matches on Subject: below --
2020-07-19 21:08 [PATCH] " Colton Lewis

Linux-GPIO Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-gpio/0 linux-gpio/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-gpio linux-gpio/ https://lore.kernel.org/linux-gpio \
		linux-gpio@vger.kernel.org
	public-inbox-index linux-gpio

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-gpio


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git