linux-kernel - Re: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <278ef62c230d69d51ca1bb4a0bbd978483f6f501.camel@perches.com>
Date:   Fri, 17 Jul 2020 12:48:04 -0700
From:   Joe Perches <joe@...ches.com>
To:     Randy Dunlap <rdunlap@...radead.org>,
        "Daniel W. S. Almeida" <dwlsalmeida@...il.com>, corbet@....net,
        mchehab@...nel.org
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings

On Fri, 2020-07-17 at 12:37 -0700, Randy Dunlap wrote:
> On 7/17/20 11:56 AM, Daniel W. S. Almeida wrote:
> > From: "Daniel W. S. Almeida" <dwlsalmeida@...il.com>
> > 
> > Fix the following warnings:
> > 
> > warning: Function parameter or member 'gc' not described in
> > 'gpiochip_add_data'
> > 
> > warning: Excess function parameter 'chip' description in
> > 'gpiochip_add_data'
> > 
> > Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@...il.com>
> 
> Mauro has already fixed this one.

Not quite fixed though.

Both patches did not update the text for chip->base where
it should have been changed to gc->base

---
 include/linux/gpio/driver.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index db82451776fc..91ae7ad8730d 100644
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -497,7 +497,7 @@ 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