Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Wed, 6 Jul 2022 23:40:02 +0200
From:   Thierry Reding <thierry.reding@gmail.com>
To:     Jonathan Corbet <corbet@lwn.net>
Cc:     Dipen Patel <dipenp@nvidia.com>,
        Mauro Carvalho Chehab <mchehab@kernel.org>,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
        Jonathan Hunter <jonathanh@nvidia.com>,
        linux-kernel@vger.kernel.org, linux-tegra@vger.kernel.org
Subject: Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c
 twice
Message-ID: <YsYBMtHLygtss+9u@orome>
References: <cover.1656759988.git.mchehab@kernel.org>
 <de81b472f552bd651f140f0aa779a29652fffa62.1656759989.git.mchehab@kernel.org>
 <7e536472-60cd-c81f-254e-bab9fda7ed37@nvidia.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha256;
        protocol="application/pgp-signature"; boundary="U+NAIL9fGoHopV43"
Content-Disposition: inline
In-Reply-To: <7e536472-60cd-c81f-254e-bab9fda7ed37@nvidia.com>
User-Agent: Mutt/2.2.6 (2022-06-05)
Precedence: bulk


--U+NAIL9fGoHopV43
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Wed, Jul 06, 2022 at 01:48:58PM -0700, Dipen Patel wrote:
> On 7/2/22 4:07 AM, Mauro Carvalho Chehab wrote:
> > All extern functions of drivers/gpio/gpiolib.c are already
> > inside the Kernel documentation, as driver-api/gpio/index.rst
> > already includes it.
> >
> > Placing a kernel-doc here will only cause mess, as the same symbol
> > will be placed on two parts of the document, causing breakages
> > in cross-references.
> >
> > So, instead, add a cross-reference there.
> >
> > This solves those Sphinx 3.1+ warnings:
> >     .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gp=
iolib.c:2464: WARNING: Duplicate C declaration, also defined at driver-api/=
gpio/index:2464.
> >     .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gp=
iolib.c:2493: WARNING: Duplicate C declaration, also defined at driver-api/=
gpio/index:2493.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Du=
plicate C declaration, also defined at driver-api/gpio/index:2464.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Du=
plicate C declaration, also defined at driver-api/gpio/index:2464.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Du=
plicate C declaration, also defined at driver-api/gpio/index:2464.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Du=
plicate C declaration, also defined at driver-api/gpio/index:2493.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Du=
plicate C declaration, also defined at driver-api/gpio/index:2493.
> >     .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Du=
plicate C declaration, also defined at driver-api/gpio/index:2493.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
> > ---
> >
> > To avoid mailbombing on a large number of people, only mailing lists we=
re C/C on the cover.
> > See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.=
mchehab@kernel.org/
> >
> >  Documentation/driver-api/hte/tegra194-hte.rst | 3 +--
> >  1 file changed, 1 insertion(+), 2 deletions(-)
> >
> > diff --git a/Documentation/driver-api/hte/tegra194-hte.rst b/Documentat=
ion/driver-api/hte/tegra194-hte.rst
> > index d29b7fe86f31..f2d617265546 100644
> > --- a/Documentation/driver-api/hte/tegra194-hte.rst
> > +++ b/Documentation/driver-api/hte/tegra194-hte.rst
> > @@ -25,8 +25,7 @@ and userspace consumers. The kernel space consumers c=
an directly talk to HTE
> >  subsystem while userspace consumers timestamp requests go through GPIO=
LIB CDEV
> >  framework to HTE subsystem.
> > =20
> > -.. kernel-doc:: drivers/gpio/gpiolib.c
> > -   :functions: gpiod_enable_hw_timestamp_ns gpiod_disable_hw_timestamp=
_ns
> > +See gpiod_enable_hw_timestamp_ns() and gpiod_disable_hw_timestamp_ns().
> > =20
> >  For userspace consumers, GPIO_V2_LINE_FLAG_EVENT_CLOCK_HTE flag must be
> >  specified during IOCTL calls. Refer to ``tools/gpio/gpio-event-mon.c``=
, which
>=20
> Acked-by: Dipen Patel <dipenp@nvidia.com>

Hi Jonathan,

here's another one that applies on top of that earlier patch. Can you
apply this to your tree?

Thanks,
Thierry

--U+NAIL9fGoHopV43
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQIzBAABCAAdFiEEiOrDCAFJzPfAjcif3SOs138+s6EFAmLGATIACgkQ3SOs138+
s6GoTQ/+MuNiUQDvboF/cEnMNnOO1FJN0Iai/Ct8u9j+ggIICgue1IaMQrUapG0q
b3Cdxo0vWzTFhlnBjjYOCH8z7t7xFvjSw9hAOcDYXILlJEOs0D3C9sQPm9AkXxW8
63ROj9bblMTWWEmYRAxNgLuMgtNr7SWCHFUwGs7XRTC9/4Hz1KyjYPQleFmTonCv
a49m7DxNpM4B/Px7P99zTjcyfiZbRx723gVBnPSiEH3sikEmGQlEShx5vjzN/4kK
q9Fed+Ef3dk7IaWjCIRjPXQ1NVV4SxDOWsgeofi0hS4p531Vg7z3MT48CQtRGJgJ
rsc2MiwwvFOg4S49jJPYAQlzrpvnrPOMYSJdwRZd/TrDGqdCmi9e6Pw1iIJERnOD
tmqXc+vkFMWRi8VNwNHi5otCMbzL0a2Z+ZaUsISOHqiIRC08cP+axryqDBec55ZB
B4FqdlJfVtufDY2Nhw65tkdiL4T3wF1e/YsHf9vqSBEUpG0J2zvyOPevpkmAGvJD
4q3ss0Ob8sy6qGGHMUhkCAMW6KinRQZnHYBWWsCXFrmAwqoRj1nq2jMQkoxdXQwl
CDh6r/MPjUh/IsF2zd7E4TQTtqxr1pD6XbIWa0/MnpiWAbXF+MUdhtp0qDlDrCvd
M5LZT8pjVX/j38u8wY7jWBQOzrqNtvawOOeNvNDhmPpmFsu4rag=
=BAQb
-----END PGP SIGNATURE-----

--U+NAIL9fGoHopV43--