ethtool: reformat kerneldoc for struct ethtool_link_settings
authorJonathan Corbet <corbet@lwn.net>
Tue, 19 Dec 2023 23:53:46 +0000 (16:53 -0700)
committerDavid S. Miller <davem@davemloft.net>
Fri, 29 Dec 2023 01:22:09 +0000 (01:22 +0000)
commitd0c3891db2d279b2f5ff8fd174e0b09e75dea039
treee8f0c2727670319f7a6d9a962fe082acedda6f80
parent144377c340f292c5d8c039eb790318754eec557e
ethtool: reformat kerneldoc for struct ethtool_link_settings

The kernel doc comments for struct ethtool_link_settings includes
documentation for three fields that were never present there, leading to
these docs-build warnings:

  ./include/uapi/linux/ethtool.h:2207: warning: Excess struct member 'supported' description in 'ethtool_link_settings'
  ./include/uapi/linux/ethtool.h:2207: warning: Excess struct member 'advertising' description in 'ethtool_link_settings'
  ./include/uapi/linux/ethtool.h:2207: warning: Excess struct member 'lp_advertising' description in 'ethtool_link_settings'

Remove the entries to make the warnings go away.  There was some
information there on how data in >link_mode_masks is formatted; move that
to the body of the comment to preserve it.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
include/uapi/linux/ethtool.h