[v0] net: phy: aquantia: fix commenting format

[PATCH v0] net: phy: aquantia: fix commenting format

Posted by Aryan Srivastava 9 months, 2 weeks ago

Comment was erroneously added with /**, amend this to use /* as it is
not a kernel-doc.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202504262247.1UBrDBVN-lkp@intel.com/
Fixes: 7e5b547cac7a ("net: phy: aquantia: poll status register")
Signed-off-by: Aryan Srivastava <aryan.srivastava@alliedtelesis.co.nz>
---
 drivers/net/phy/aquantia/aquantia_main.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/net/phy/aquantia/aquantia_main.c b/drivers/net/phy/aquantia/aquantia_main.c
index 08b1c9cc902b..77a48635d7bf 100644
--- a/drivers/net/phy/aquantia/aquantia_main.c
+++ b/drivers/net/phy/aquantia/aquantia_main.c
@@ -516,8 +516,7 @@ static int aqr105_read_status(struct phy_device *phydev)
 	if (!phydev->link || phydev->autoneg == AUTONEG_DISABLE)
 		return 0;
 
-	/**
-	 * The status register is not immediately correct on line side link up.
+	/* The status register is not immediately correct on line side link up.
 	 * Poll periodically until it reflects the correct ON state.
 	 * Only return fail for read error, timeout defaults to OFF state.
 	 */
@@ -634,8 +633,7 @@ static int aqr107_read_status(struct phy_device *phydev)
 	if (!phydev->link || phydev->autoneg == AUTONEG_DISABLE)
 		return 0;
 
-	/**
-	 * The status register is not immediately correct on line side link up.
+	/* The status register is not immediately correct on line side link up.
 	 * Poll periodically until it reflects the correct ON state.
 	 * Only return fail for read error, timeout defaults to OFF state.
 	 */
-- 
2.49.0

Re: [PATCH v0] net: phy: aquantia: fix commenting format

Posted by Andrew Lunn 9 months, 2 weeks ago

On Mon, Apr 28, 2025 at 12:32:48PM +1200, Aryan Srivastava wrote:
> Comment was erroneously added with /**, amend this to use /* as it is
> not a kernel-doc.
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202504262247.1UBrDBVN-lkp@intel.com/
> Fixes: 7e5b547cac7a ("net: phy: aquantia: poll status register")
> Signed-off-by: Aryan Srivastava <aryan.srivastava@alliedtelesis.co.nz>

The Fixes tag somewhat implies this should be backported in
stable. But a comment does not really bother anybody, so does not meet
the stable criteria.

Please drop the tag and submit for net-next.

https://www.kernel.org/doc/html/latest/process/maintainer-netdev.html

	Andrew