mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] ethtool: fix incorrect kernel-doc style comment in ethtool.h
@ 2025-11-10 18:25 Kriish Sharma
  2025-11-12  1:50 ` patchwork-bot+netdevbpf
  0 siblings, 1 reply; 2+ messages in thread
From: Kriish Sharma @ 2025-11-10 18:25 UTC (permalink / raw)
  To: Andrew Lunn, Jakub Kicinski, David S . Miller, Eric Dumazet,
	Paolo Abeni, Simon Horman
  Cc: netdev, linux-kernel, Kriish Sharma

Building documentation produced the following warning:

  WARNING: ./include/linux/ethtool.h:495 This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * IEEE 802.3ck/df defines 16 bins for FEC histogram plus one more for

This comment was not intended to be parsed as kernel-doc, so replace
the '/**' with '/*' to silence the warning and align with normal
comment style in header files.

No functional changes.

Fixes: cc2f08129925 ("ethtool: add FEC bins histogram report")
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
---
 include/linux/ethtool.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/ethtool.h b/include/linux/ethtool.h
index c2d8b4ec62eb..5c9162193d26 100644
--- a/include/linux/ethtool.h
+++ b/include/linux/ethtool.h
@@ -492,7 +492,7 @@ struct ethtool_pause_stats {
 };
 
 #define ETHTOOL_MAX_LANES	8
-/**
+/*
  * IEEE 802.3ck/df defines 16 bins for FEC histogram plus one more for
  * the end-of-list marker, total 17 items
  */
-- 
2.34.1


^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] ethtool: fix incorrect kernel-doc style comment in ethtool.h
  2025-11-10 18:25 [PATCH] ethtool: fix incorrect kernel-doc style comment in ethtool.h Kriish Sharma
@ 2025-11-12  1:50 ` patchwork-bot+netdevbpf
  0 siblings, 0 replies; 2+ messages in thread
From: patchwork-bot+netdevbpf @ 2025-11-12  1:50 UTC (permalink / raw)
  To: Kriish Sharma
  Cc: andrew, kuba, davem, edumazet, pabeni, horms, netdev, linux-kernel

Hello:

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

On Mon, 10 Nov 2025 18:25:45 +0000 you wrote:
> Building documentation produced the following warning:
> 
>   WARNING: ./include/linux/ethtool.h:495 This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * IEEE 802.3ck/df defines 16 bins for FEC histogram plus one more for
> 
> This comment was not intended to be parsed as kernel-doc, so replace
> the '/**' with '/*' to silence the warning and align with normal
> comment style in header files.
> 
> [...]

Here is the summary with links:
  - ethtool: fix incorrect kernel-doc style comment in ethtool.h
    https://git.kernel.org/netdev/net/c/bb8336a5163a

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



^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-11-12  1:50 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-11-10 18:25 [PATCH] ethtool: fix incorrect kernel-doc style comment in ethtool.h Kriish Sharma
2025-11-12  1:50 ` patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®