[PATCH -net] net: hisilicon: fix hsn3_ethtool kernel-doc warnings

STALE1734d

2 messages, 2 authors, 2021-11-07 · open the first message on its own page

[PATCH -net] net: hisilicon: fix hsn3_ethtool kernel-doc warnings

From: Randy Dunlap <hidden>
Date: 2021-11-06 03:29:17

Fix kernel-doc warnings and spacing in hns3_ethtool.c:

hns3_ethtool.c:246: warning: No description found for return value of 'hns3_lp_run_test'
hns3_ethtool.c:408: warning: expecting prototype for hns3_nic_self_test(). Prototype was for hns3_self_test() instead

Signed-off-by: Randy Dunlap <redacted>
Reported-by: kernel test robot <redacted>
Cc: Peng Li <redacted>
Cc: Guangbin Huang <redacted>
Cc: Yisen Zhuang <redacted>
Cc: Salil Mehta <redacted>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
---
 drivers/net/ethernet/hisilicon/hns3/hns3_ethtool.c |    6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
--- linux-next-20211106.orig/drivers/net/ethernet/hisilicon/hns3/hns3_ethtool.c
+++ linux-next-20211106/drivers/net/ethernet/hisilicon/hns3/hns3_ethtool.c
@@ -238,9 +238,11 @@ static void hns3_lb_clear_tx_ring(struct
 }
 
 /**
- * hns3_lp_run_test -  run loopback test
+ * hns3_lp_run_test - run loopback test
  * @ndev: net device
  * @mode: loopback type
+ *
+ * Return: %0 for success or a NIC loopback test error code on failure
  */
 static int hns3_lp_run_test(struct net_device *ndev, enum hnae3_loop mode)
 {
@@ -398,7 +400,7 @@ static void hns3_do_selftest(struct net_
 }
 
 /**
- * hns3_nic_self_test - self test
+ * hns3_self_test - self test
  * @ndev: net device
  * @eth_test: test cmd
  * @data: test result

Re: [PATCH -net] net: hisilicon: fix hsn3_ethtool kernel-doc warnings

From: patchwork-bot+netdevbpf@kernel.org
Date: 2021-11-07 19:30:09

Hello:

This patch was applied to netdev/net.git (master)
by David S. Miller [off-list ref]:

On Fri,  5 Nov 2021 20:14:41 -0700 you wrote:
Fix kernel-doc warnings and spacing in hns3_ethtool.c:

hns3_ethtool.c:246: warning: No description found for return value of 'hns3_lp_run_test'
hns3_ethtool.c:408: warning: expecting prototype for hns3_nic_self_test(). Prototype was for hns3_self_test() instead

Signed-off-by: Randy Dunlap <redacted>
Reported-by: kernel test robot <redacted>
Cc: Peng Li <redacted>
Cc: Guangbin Huang <redacted>
Cc: Yisen Zhuang <redacted>
Cc: Salil Mehta <redacted>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>

[...]
Here is the summary with links:
  - [-net] net: hisilicon: fix hsn3_ethtool kernel-doc warnings
    https://git.kernel.org/netdev/net/c/85879f131d78

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

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help