Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Message-ID: <278ef62c230d69d51ca1bb4a0bbd978483f6f501.camel@perches.com>
Subject: Re: [PATCH 07/25] Documentation: gpio/driver.h: fix sphinx warnings
From:   Joe Perches <joe@perches.com>
To:     Randy Dunlap <rdunlap@infradead.org>,
        "Daniel W. S. Almeida" <dwlsalmeida@gmail.com>, corbet@lwn.net,
        mchehab@kernel.org
Cc:     linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Date:   Fri, 17 Jul 2020 12:48:04 -0700
In-Reply-To: <684c5c2e-1b2d-bcb4-1320-a3a0dbed9b70@infradead.org>
References: <20200717185624.2009393-1-dwlsalmeida@gmail.com>
         <20200717185624.2009393-7-dwlsalmeida@gmail.com>
         <684c5c2e-1b2d-bcb4-1320-a3a0dbed9b70@infradead.org>
Content-Type: text/plain; charset="ISO-8859-1"
User-Agent: Evolution 3.36.3-0ubuntu1 
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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@gmail.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@gmail.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