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

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

[Aryan Srivastava]

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/
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 net-next v0] net: phy: aquantia: fix commenting format

[Simon Horman]

On Tue, Apr 29, 2025 at 09:49:20AM +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/
> Signed-off-by: Aryan Srivastava <aryan.srivastava@alliedtelesis.co.nz>

Thanks.

Strangely ./scripts/kernel-doc -Wall -none has nothing to say about this.

But the file is clean in that respect (both before and after this change);
I agree this is correct; And I couldn't find any other instances of this
problem under rivers/net/phy/aquantia/

Reviewed-by: Simon Horman <horms@kernel.org>

...

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

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Tue, 29 Apr 2025 09:49:20 +1200 you 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/
> Signed-off-by: Aryan Srivastava <aryan.srivastava@alliedtelesis.co.nz>
> 
> [...]

Here is the summary with links:
  - [net-next,v0] net: phy: aquantia: fix commenting format
    https://git.kernel.org/netdev/net-next/c/aa6dcab1ea92

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html