All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jules Maselbas <jmaselbas@kalray.eu>
To: linux-phy@lists.infradead.org
Cc: linux-usb@vger.kernel.org, Kishon Vijay Abraham I <kishon@ti.com>,
	Vinod Koul <vkoul@kernel.org>,
	Ahmad Fatoum <a.fatoum@pengutronix.de>,
	Minas Harutyunyan <hminas@synopsys.com>,
	Amelie DELAUNAY <amelie.delaunay@foss.st.com>,
	Yann Sionneau <ysionneau@kalray.eu>,
	Michael Grzeschik <mgr@pengutronix.de>,
	Randy Dunlap <rdunlap@infradead.org>,
	Arnd Bergmann <arnd@arndb.de>,
	Jules Maselbas <jmaselbas@kalray.eu>
Subject: [PATCH RESEND v3 2/3] phy: core: Update documentation syntax
Date: Thu,  7 Apr 2022 12:21:07 +0200	[thread overview]
Message-ID: <20220407102108.24211-3-jmaselbas@kalray.eu> (raw)
In-Reply-To: <20220407102108.24211-1-jmaselbas@kalray.eu>

Update the syntax used by the documentation of phy operation functions.
This is to unify the syntax with the newly added documentation.

Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu>
---
v2: new patch
v3: no change

 drivers/phy/phy-core.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/phy/phy-core.c b/drivers/phy/phy-core.c
index d1817a0f2d09..d11b517e283a 100644
--- a/drivers/phy/phy-core.c
+++ b/drivers/phy/phy-core.c
@@ -467,7 +467,7 @@ EXPORT_SYMBOL_GPL(phy_reset);
  * runtime, which are otherwise lost after host controller reset and cannot
  * be applied in phy_init() or phy_power_on().
  *
- * Returns: 0 if successful, an negative error code otherwise
+ * Return: %0 if successful, a negative error code otherwise
  */
 int phy_calibrate(struct phy *phy)
 {
@@ -493,7 +493,7 @@ EXPORT_SYMBOL_GPL(phy_calibrate);
  * on the phy. The configuration will be applied on the current phy
  * mode, that can be changed using phy_set_mode().
  *
- * Returns: 0 if successful, an negative error code otherwise
+ * Return: %0 if successful, a negative error code otherwise
  */
 int phy_configure(struct phy *phy, union phy_configure_opts *opts)
 {
@@ -527,7 +527,7 @@ EXPORT_SYMBOL_GPL(phy_configure);
  * PHY, so calling it as many times as deemed fit will have no side
  * effect.
  *
- * Returns: 0 if successful, an negative error code otherwise
+ * Return: %0 if successful, a negative error code otherwise
  */
 int phy_validate(struct phy *phy, enum phy_mode mode, int submode,
 		 union phy_configure_opts *opts)
-- 
2.17.1


WARNING: multiple messages have this Message-ID (diff)
From: Jules Maselbas <jmaselbas@kalray.eu>
To: linux-phy@lists.infradead.org
Cc: linux-usb@vger.kernel.org, Kishon Vijay Abraham I <kishon@ti.com>,
	Vinod Koul <vkoul@kernel.org>,
	Ahmad Fatoum <a.fatoum@pengutronix.de>,
	Minas Harutyunyan <hminas@synopsys.com>,
	Amelie DELAUNAY <amelie.delaunay@foss.st.com>,
	Yann Sionneau <ysionneau@kalray.eu>,
	Michael Grzeschik <mgr@pengutronix.de>,
	Randy Dunlap <rdunlap@infradead.org>,
	Arnd Bergmann <arnd@arndb.de>,
	Jules Maselbas <jmaselbas@kalray.eu>
Subject: [PATCH RESEND v3 2/3] phy: core: Update documentation syntax
Date: Thu,  7 Apr 2022 12:21:07 +0200	[thread overview]
Message-ID: <20220407102108.24211-3-jmaselbas@kalray.eu> (raw)
In-Reply-To: <20220407102108.24211-1-jmaselbas@kalray.eu>

Update the syntax used by the documentation of phy operation functions.
This is to unify the syntax with the newly added documentation.

Signed-off-by: Jules Maselbas <jmaselbas@kalray.eu>
---
v2: new patch
v3: no change

 drivers/phy/phy-core.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/phy/phy-core.c b/drivers/phy/phy-core.c
index d1817a0f2d09..d11b517e283a 100644
--- a/drivers/phy/phy-core.c
+++ b/drivers/phy/phy-core.c
@@ -467,7 +467,7 @@ EXPORT_SYMBOL_GPL(phy_reset);
  * runtime, which are otherwise lost after host controller reset and cannot
  * be applied in phy_init() or phy_power_on().
  *
- * Returns: 0 if successful, an negative error code otherwise
+ * Return: %0 if successful, a negative error code otherwise
  */
 int phy_calibrate(struct phy *phy)
 {
@@ -493,7 +493,7 @@ EXPORT_SYMBOL_GPL(phy_calibrate);
  * on the phy. The configuration will be applied on the current phy
  * mode, that can be changed using phy_set_mode().
  *
- * Returns: 0 if successful, an negative error code otherwise
+ * Return: %0 if successful, a negative error code otherwise
  */
 int phy_configure(struct phy *phy, union phy_configure_opts *opts)
 {
@@ -527,7 +527,7 @@ EXPORT_SYMBOL_GPL(phy_configure);
  * PHY, so calling it as many times as deemed fit will have no side
  * effect.
  *
- * Returns: 0 if successful, an negative error code otherwise
+ * Return: %0 if successful, a negative error code otherwise
  */
 int phy_validate(struct phy *phy, enum phy_mode mode, int submode,
 		 union phy_configure_opts *opts)
-- 
2.17.1


-- 
linux-phy mailing list
linux-phy@lists.infradead.org
https://lists.infradead.org/mailman/listinfo/linux-phy

  parent reply	other threads:[~2022-04-07 10:21 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-07 10:21 [PATCH RESEND v3 0/3] Cleanup the call ordering of phy_init and phy_power_on Jules Maselbas
2022-04-07 10:21 ` Jules Maselbas
2022-04-07 10:21 ` [PATCH RESEND v3 1/3] phy: core: Add documentation of phy operation order Jules Maselbas
2022-04-07 10:21   ` Jules Maselbas
2022-04-07 10:21 ` Jules Maselbas [this message]
2022-04-07 10:21   ` [PATCH RESEND v3 2/3] phy: core: Update documentation syntax Jules Maselbas
2022-04-13  6:02   ` Vinod Koul
2022-04-13  6:02     ` Vinod Koul
2022-04-13  9:53     ` Jules Maselbas
2022-04-13  9:53       ` Jules Maselbas
2022-04-13  9:59       ` Vinod Koul
2022-04-13  9:59         ` Vinod Koul
2022-04-13 11:13         ` Jules Maselbas
2022-04-13 11:13           ` Jules Maselbas
2022-04-07 10:21 ` [PATCH RESEND v3 3/3] phy: core: Warn when phy_power_on is called before phy_init Jules Maselbas
2022-04-07 10:21   ` Jules Maselbas
2022-04-20  9:15 ` [PATCH RESEND v3 0/3] Cleanup the call ordering of phy_init and phy_power_on Vinod Koul
2022-04-20  9:15   ` Vinod Koul

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=20220407102108.24211-3-jmaselbas@kalray.eu \
    --to=jmaselbas@kalray.eu \
    --cc=a.fatoum@pengutronix.de \
    --cc=amelie.delaunay@foss.st.com \
    --cc=arnd@arndb.de \
    --cc=hminas@synopsys.com \
    --cc=kishon@ti.com \
    --cc=linux-phy@lists.infradead.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=mgr@pengutronix.de \
    --cc=rdunlap@infradead.org \
    --cc=vkoul@kernel.org \
    --cc=ysionneau@kalray.eu \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.