mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	Dipen Patel <dipenp@nvidia.com>,
	Jonathan Hunter <jonathanh@nvidia.com>,
	Thierry Reding <thierry.reding@gmail.com>,
	linux-kernel@vger.kernel.org, linux-tegra@vger.kernel.org
Subject: [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice
Date: Sat,  2 Jul 2022 12:07:34 +0100	[thread overview]
Message-ID: <de81b472f552bd651f140f0aa779a29652fffa62.1656759989.git.mchehab@kernel.org> (raw)
In-Reply-To: <cover.1656759988.git.mchehab@kernel.org>

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
-- 
2.36.1


  parent reply	other threads:[~2022-07-02 11:08 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-02 11:07 [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 01/12] docs: ext4: blockmap.rst: fix a broken table Mauro Carvalho Chehab
2022-07-02 11:07 ` Mauro Carvalho Chehab [this message]
2022-07-06 20:48   ` [PATCH 02/12] docs: tegra194-hte.rst: don't include gpiolib.c twice Dipen Patel
2022-07-06 21:40     ` Thierry Reding
2022-07-07 18:54       ` Jonathan Corbet
2022-07-02 11:07 ` [PATCH 03/12] docs: device-mapper: add a blank line at writecache.rst Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 04/12] docs: PCI: pci-vntb-function.rst: Properly include ascii artwork Mauro Carvalho Chehab
2022-07-12 19:57   ` Bjorn Helgaas
2022-07-02 11:07 ` [PATCH 05/12] docs: PCI: pci-vntb-howto.rst: fix a title markup Mauro Carvalho Chehab
2022-07-12 19:58   ` Bjorn Helgaas
2022-07-02 11:07 ` [PATCH 06/12] docs: virt: kvm: fix a title markup at api.rst Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 07/12] docs: ABI: sysfs-bus-nvdimm Mauro Carvalho Chehab
2022-07-07  5:31   ` kajoljain
2022-07-02 11:07 ` [PATCH 08/12] kunit: test.h: fix a kernel-doc markup Mauro Carvalho Chehab
2022-07-02 13:18   ` David Gow
2022-07-08 17:30     ` Shuah Khan
2022-07-02 11:07 ` [PATCH 09/12] net: mac80211: " Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 10/12] docs: alsa: alsa-driver-api.rst: remove a kernel-doc file Mauro Carvalho Chehab
2022-07-04 12:54   ` Takashi Iwai
2022-07-09  9:56     ` Mauro Carvalho Chehab
2022-07-02 11:07 ` [PATCH 11/12] docs: arm: index.rst: add google/chromebook-boot-flow Mauro Carvalho Chehab
2022-07-06 16:34   ` Doug Anderson
2022-07-06 22:29     ` Doug Anderson
2022-07-08 22:19   ` (subset) " Bjorn Andersson
2022-07-02 11:07 ` [PATCH 12/12] docs: leds: index.rst: add leds-qcom-lpg to it Mauro Carvalho Chehab
2022-07-03  3:26 ` [PATCH 00/12] Fix several documentation build warnings with Sphinx 2.4.4 Bagas Sanjaya

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=de81b472f552bd651f140f0aa779a29652fffa62.1656759989.git.mchehab@kernel.org \
    --to=mchehab@kernel.org \
    --cc=corbet@lwn.net \
    --cc=dipenp@nvidia.com \
    --cc=jonathanh@nvidia.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-tegra@vger.kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=thierry.reding@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

Powered by JetHome