From: "Kory Maincent (Dent Project)" <kory.maincent@bootlin.com>
To: Oleksij Rempel <o.rempel@pengutronix.de>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>,
Paolo Abeni <pabeni@redhat.com>, Andrew Lunn <andrew@lunn.ch>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
Kyle Swenson <kyle.swenson@est.tech>,
Kory Maincent <kory.maincent@bootlin.com>
Subject: [PATCH net-next v2 1/3] net: pse-pd: pse_core: Add missing kdoc return description
Date: Mon, 22 Apr 2024 15:35:46 +0200 [thread overview]
Message-ID: <20240422-fix_poe-v2-1-e58325950f07@bootlin.com> (raw)
In-Reply-To: <20240422-fix_poe-v2-0-e58325950f07@bootlin.com>
From: Kory Maincent (Dent Project) <kory.maincent@bootlin.com>
Add missing kernel documentation return description.
This allows to remove all warning from kernel-doc test script.
Reviewed-by: Andrew Lunn <andrew@lunn.ch>
Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
---
drivers/net/pse-pd/pse_core.c | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/drivers/net/pse-pd/pse_core.c b/drivers/net/pse-pd/pse_core.c
index 31f23c454678..bad29eaa4d01 100644
--- a/drivers/net/pse-pd/pse_core.c
+++ b/drivers/net/pse-pd/pse_core.c
@@ -320,6 +320,8 @@ devm_pse_pi_regulator_register(struct pse_controller_dev *pcdev,
/**
* pse_controller_register - register a PSE controller device
* @pcdev: a pointer to the initialized PSE controller device
+ *
+ * Return: 0 on success and failure value on error
*/
int pse_controller_register(struct pse_controller_dev *pcdev)
{
@@ -401,6 +403,8 @@ static void devm_pse_controller_release(struct device *dev, void *res)
* Managed pse_controller_register(). For PSE controllers registered by
* this function, pse_controller_unregister() is automatically called on
* driver detach. See pse_controller_register() for more information.
+ *
+ * Return: 0 on success and failure value on error
*/
int devm_pse_controller_register(struct device *dev,
struct pse_controller_dev *pcdev)
@@ -627,6 +631,8 @@ EXPORT_SYMBOL_GPL(of_pse_control_get);
* @psec: PSE control pointer
* @extack: extack for reporting useful error messages
* @status: struct to store PSE status
+ *
+ * Return: 0 on success and failure value on error
*/
int pse_ethtool_get_status(struct pse_control *psec,
struct netlink_ext_ack *extack,
@@ -704,6 +710,8 @@ static int pse_ethtool_podl_set_config(struct pse_control *psec,
* @psec: PSE control pointer
* @extack: extack for reporting useful error messages
* @config: Configuration of the test to run
+ *
+ * Return: 0 on success and failure value on error
*/
int pse_ethtool_set_config(struct pse_control *psec,
struct netlink_ext_ack *extack,
--
2.34.1
next prev parent reply other threads:[~2024-04-22 13:36 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-22 13:35 [PATCH net-next v2 0/3] net: pse-pd: Fixes for few small issues Kory Maincent (Dent Project)
2024-04-22 13:35 ` Kory Maincent (Dent Project) [this message]
2024-04-23 8:49 ` [PATCH net-next v2 1/3] net: pse-pd: pse_core: Add missing kdoc return description Oleksij Rempel
2024-04-22 13:35 ` [PATCH net-next v2 2/3] net: pse-pd: pse_core: Fix pse regulator type Kory Maincent (Dent Project)
2024-04-22 15:02 ` Jiri Pirko
2024-04-22 16:20 ` Kory Maincent
2024-04-23 8:48 ` Oleksij Rempel
2024-04-22 13:35 ` [PATCH net-next v2 3/3] net: pse-pd: Kconfig: Add missing Regulator API dependency Kory Maincent (Dent Project)
2024-04-23 8:50 ` Oleksij Rempel
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=20240422-fix_poe-v2-1-e58325950f07@bootlin.com \
--to=kory.maincent@bootlin.com \
--cc=andrew@lunn.ch \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=kuba@kernel.org \
--cc=kyle.swenson@est.tech \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=o.rempel@pengutronix.de \
--cc=pabeni@redhat.com \
--cc=thomas.petazzoni@bootlin.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;
as well as URLs for NNTP newsgroup(s).