Re: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice

Thierry Reding
2022-07-06T21:40:12Z

[-- Attachment #1: Type: text/plain, Size: 3188 bytes --]

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/gpiolib.c:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
> > .../Documentation/driver-api/hte/tegra194-hte:28: ./drivers/gpio/gpiolib.c:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
> > .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
> > .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
> > .../Documentation/driver-api/hte/tegra194-hte.rst:2464: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2464.
> > .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
> > .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate C declaration, also defined at driver-api/gpio/index:2493.
> > .../Documentation/driver-api/hte/tegra194-hte.rst:2493: WARNING: Duplicate 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 were 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/Documentation/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 can directly talk to HTE
> > subsystem while userspace consumers timestamp requests go through GPIOLIB CDEV
> > framework to HTE subsystem.
> >
> > -.. 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().
> >
> > 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
>
> 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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]