diff options
| author |   Jonathan Corbet <corbet@lwn.net> | 2023-12-19 16:55:31 -0700 |
|---|---|---|
| committer |   David S. Miller <davem@davemloft.net> | 2023-12-29 01:22:59 +0000 |
| commit | 1271ca00aa7f9bb3fd94cb7ac8f654de71099580 (patch) | |
| tree | 2c053106aab811687b676aeaa9874d76d5ea7ba7 | |
| parent | ethtool: reformat kerneldoc for struct ethtool_link_settings (diff) | |
| download | wireguard-linux-1271ca00aa7f9bb3fd94cb7ac8f654de71099580.tar.xz wireguard-linux-1271ca00aa7f9bb3fd94cb7ac8f654de71099580.zip | |
ethtool: reformat kerneldoc for struct ethtool_fec_stats
The kerneldoc comment for struct ethtool_fec_stats attempts to describe the
"total" and "lanes" fields of the ethtool_fec_stat substructure in a way
leading to these warnings:
./include/linux/ethtool.h:424: warning: Excess struct member 'lane' description in 'ethtool_fec_stats'
./include/linux/ethtool.h:424: warning: Excess struct member 'total' description in 'ethtool_fec_stats'
Reformat the comment to retain the information while eliminating the
warnings.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
| -rw-r--r-- | include/linux/ethtool.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/include/linux/ethtool.h b/include/linux/ethtool.h index cfcd952a1d4f..325e0778e937 100644 --- a/include/linux/ethtool.h +++ b/include/linux/ethtool.h @@ -411,8 +411,10 @@ struct ethtool_pause_stats { * not entire FEC data blocks. This is a non-standard statistic. * Reported to user space as %ETHTOOL_A_FEC_STAT_CORR_BITS. * - * @lane: per-lane/PCS-instance counts as defined by the standard - * @total: error counts for the entire port, for drivers incapable of reporting + * For each of the above fields, the two substructure members are: + * + * - @lanes: per-lane/PCS-instance counts as defined by the standard + * - @total: error counts for the entire port, for drivers incapable of reporting * per-lane stats * * Drivers should fill in either only total or per-lane statistics, core |