Re: [PATCH net] ethtool: reformat kerneldoc for struct ethtool_fec_stats

[Randy Dunlap]

On 12/19/23 15:55, Jonathan Corbet wrote:
> 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@xxxxxxx>

Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

> ---
>  include/linux/ethtool.h | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/ethtool.h b/include/linux/ethtool.h
> index 689028257fcc..77c7a9ac0ece 100644
> --- a/include/linux/ethtool.h
> +++ b/include/linux/ethtool.h
> @@ -409,8 +409,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

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html