From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
"Jonathan Corbet" <corbet@lwn.net>, Andrew Lunn <andrew@lunn.ch>,
Heiner Kallweit <hkallweit1@gmail.com>,
Russell King <linux@armlinux.org.uk>,
linux-kernel@vger.kernel.org, netdev@vger.kernel.org
Subject: [PATCH v2 19/24] net: phy: remove kernel-doc duplication
Date: Tue, 13 Oct 2020 14:14:46 +0200 [thread overview]
Message-ID: <89c130eab83089f7976ed8876e9bd1ba62d800c3.1602590106.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1602590106.git.mchehab+huawei@kernel.org>
Sphinx 3 now checks for duplicated function declarations:
.../Documentation/networking/kapi:143: ../include/linux/phy.h:163: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
Declaration is 'unsigned int phy_supported_speeds (struct phy_device *phy, unsigned int *speeds, unsigned int size)'.
.../Documentation/networking/kapi:143: ../include/linux/phy.h:1034: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
Declaration is 'int phy_read_mmd (struct phy_device *phydev, int devad, u32 regnum)'.
.../Documentation/networking/kapi:143: ../include/linux/phy.h:1076: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
Declaration is 'int __phy_read_mmd (struct phy_device *phydev, int devad, u32 regnum)'.
.../Documentation/networking/kapi:143: ../include/linux/phy.h:1088: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
Declaration is 'int phy_write_mmd (struct phy_device *phydev, int devad, u32 regnum, u16 val)'.
.../Documentation/networking/kapi:143: ../include/linux/phy.h:1100: WARNING: Duplicate C declaration, also defined in 'networking/kapi'.
Declaration is 'int __phy_write_mmd (struct phy_device *phydev, int devad, u32 regnum, u16 val)'.
It turns that both the C and the H files have the same
kernel-doc markup for the same functions. Let's drop the
at the header file, keeping the one closer to the code.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
include/linux/phy.h | 40 +++++-----------------------------------
1 file changed, 5 insertions(+), 35 deletions(-)
diff --git a/include/linux/phy.h b/include/linux/phy.h
index eb3cb1a98b45..56563e5e0dc7 100644
--- a/include/linux/phy.h
+++ b/include/linux/phy.h
@@ -147,16 +147,8 @@ typedef enum {
PHY_INTERFACE_MODE_MAX,
} phy_interface_t;
-/**
+/*
* phy_supported_speeds - return all speeds currently supported by a PHY device
- * @phy: The PHY device to return supported speeds of.
- * @speeds: buffer to store supported speeds in.
- * @size: size of speeds buffer.
- *
- * Description: Returns the number of supported speeds, and fills
- * the speeds buffer with the supported speeds. If speeds buffer is
- * too small to contain all currently supported speeds, will return as
- * many speeds as can fit.
*/
unsigned int phy_supported_speeds(struct phy_device *phy,
unsigned int *speeds,
@@ -1022,14 +1014,9 @@ static inline int __phy_modify_changed(struct phy_device *phydev, u32 regnum,
regnum, mask, set);
}
-/**
+/*
* phy_read_mmd - Convenience function for reading a register
* from an MMD on a given PHY.
- * @phydev: The phy_device struct
- * @devad: The MMD to read from
- * @regnum: The register on the MMD to read
- *
- * Same rules as for phy_read();
*/
int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
@@ -1064,38 +1051,21 @@ int phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
__ret; \
})
-/**
+/*
* __phy_read_mmd - Convenience function for reading a register
* from an MMD on a given PHY.
- * @phydev: The phy_device struct
- * @devad: The MMD to read from
- * @regnum: The register on the MMD to read
- *
- * Same rules as for __phy_read();
*/
int __phy_read_mmd(struct phy_device *phydev, int devad, u32 regnum);
-/**
+/*
* phy_write_mmd - Convenience function for writing a register
* on an MMD on a given PHY.
- * @phydev: The phy_device struct
- * @devad: The MMD to write to
- * @regnum: The register on the MMD to read
- * @val: value to write to @regnum
- *
- * Same rules as for phy_write();
*/
int phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
-/**
+/*
* __phy_write_mmd - Convenience function for writing a register
* on an MMD on a given PHY.
- * @phydev: The phy_device struct
- * @devad: The MMD to write to
- * @regnum: The register on the MMD to read
- * @val: value to write to @regnum
- *
- * Same rules as for __phy_write();
*/
int __phy_write_mmd(struct phy_device *phydev, int devad, u32 regnum, u16 val);
--
2.26.2
next prev parent reply other threads:[~2020-10-13 12:15 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-13 12:14 [PATCH v2 00/24] Documentation build fixes against next-20201013 Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 01/24] docs: hwmon: adm1266.rst: fix a broken reference Mauro Carvalho Chehab
2020-10-13 16:48 ` Guenter Roeck
2020-10-13 12:14 ` [PATCH v2 02/24] tools: docs: memory-model: fix references for some files Mauro Carvalho Chehab
2020-10-13 16:33 ` Paul E. McKenney
2020-10-13 16:38 ` Alan Stern
2020-10-14 1:58 ` Paul E. McKenney
2020-10-14 7:56 ` Mauro Carvalho Chehab
2020-10-14 14:14 ` Akira Yokosawa
2020-10-14 14:39 ` Mauro Carvalho Chehab
2020-10-14 18:57 ` Paul E. McKenney
2020-10-15 5:15 ` Mauro Carvalho Chehab
2020-10-15 10:30 ` Peter Zijlstra
2020-10-13 12:14 ` [PATCH v2 03/24] docs: SafeSetID: fix a warning Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 04/24] docs: lockdep-design: fix some warning issues Mauro Carvalho Chehab
2020-10-13 12:52 ` Peter Zijlstra
2020-10-13 13:11 ` Matthew Wilcox
2020-10-13 14:09 ` Peter Zijlstra
2020-10-13 15:02 ` Matthew Wilcox
2020-10-14 16:04 ` Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 05/24] docs: admin-guide: net.rst: add a missing blank line Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 06/24] blk-mq: docs: add kernel-doc description for a new struct member Mauro Carvalho Chehab
2020-10-13 13:29 ` John Garry
2020-10-13 19:12 ` Jens Axboe
2020-10-13 12:14 ` [PATCH v2 07/24] drm: amdgpu: kernel-doc: update some adev parameters Mauro Carvalho Chehab
2020-10-13 12:41 ` Christian König
2020-10-13 12:14 ` [PATCH v2 08/24] drm: kernel-doc: document drm_dp_set_subconnector_property() params Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 09/24] docs: kasan.rst: add two missing blank lines Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 10/24] mm: pagemap.h: fix two kernel-doc markups Mauro Carvalho Chehab
2020-10-13 12:26 ` Matthew Wilcox
2020-10-21 9:55 ` Mauro Carvalho Chehab
2020-10-21 11:28 ` Matthew Wilcox
2020-10-21 11:59 ` Mauro Carvalho Chehab
2020-10-21 12:02 ` Matthew Wilcox
2020-10-13 12:14 ` [PATCH v2 11/24] drm/dp: fix kernel-doc warnings at drm_dp_helper.c Mauro Carvalho Chehab
2020-10-13 19:20 ` Lyude Paul
2020-10-13 12:14 ` [PATCH v2 12/24] drm/dp: fix a kernel-doc issue at drm_edid.c Mauro Carvalho Chehab
2020-10-13 19:24 ` Lyude Paul
2020-10-13 19:49 ` Lyude Paul
2020-10-21 10:11 ` Mauro Carvalho Chehab
2020-10-21 16:56 ` Lyude Paul
2020-10-13 12:14 ` [PATCH v2 13/24] docs: i2c: index.rst: add slave-testunit-backend.rst Mauro Carvalho Chehab
2020-10-13 15:53 ` Wolfram Sang
2020-10-13 12:14 ` [PATCH v2 14/24] docs: conf.py: disable automarkup for Sphinx 3.x Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 15/24] docs: net: statistics.rst: remove a duplicated kernel-doc Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 16/24] seqlock: fix two kernel-doc warnings Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 17/24] docs: hwmon: mp2975.rst: address some html build warnings Mauro Carvalho Chehab
2020-10-13 16:48 ` Guenter Roeck
2020-10-13 12:14 ` [PATCH v2 18/24] docs: userspace-api: add iommu.rst to the index file Mauro Carvalho Chehab
2020-10-13 12:14 ` Mauro Carvalho Chehab [this message]
2020-10-13 12:14 ` [PATCH v2 20/24] MAINTAINERS: fix broken doc refs due to yaml conversion Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 21/24] crypto: sun8x-ce*: update entries to its documentation Mauro Carvalho Chehab
2020-10-13 12:14 ` [PATCH v2 22/24] ice: docs fix a devlink info that broke a table Mauro Carvalho Chehab
2020-10-13 22:01 ` Jacob Keller
2020-10-13 12:14 ` [PATCH v2 23/24] RDMA: add a missing kernel-doc parameter markup Mauro Carvalho Chehab
2020-10-16 16:57 ` Jason Gunthorpe
2020-10-13 12:14 ` [PATCH v2 24/24] counters: docs: add a missing include Mauro Carvalho Chehab
2020-10-15 1:06 ` Shuah Khan
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=89c130eab83089f7976ed8876e9bd1ba62d800c3.1602590106.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=andrew@lunn.ch \
--cc=corbet@lwn.net \
--cc=hkallweit1@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=netdev@vger.kernel.org \
/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;
as well as URLs for NNTP newsgroup(s).