[PATCH] ethtool: fix incorrect kernel-doc style comment in ethtool.h

Kriish Sharma posted 1 patch 2 months, 4 weeks ago
include/linux/ethtool.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] ethtool: fix incorrect kernel-doc style comment in ethtool.h
Posted by Kriish Sharma 2 months, 4 weeks ago
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