History

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.

Jonathan Corbet committed 2 years ago

Commit d0c38911 parent 144377c1 file · +15 −12Browse files

Unified · Split

include/uapi/linux/ethtool.h+15−12
@@ -2139,18 +2139,6 @@ enum ethtool_reset_flags { · 2138 unmodified lines
2139 * refused. For drivers: ignore this field (use kernel's2139 * refused. For drivers: ignore this field (use kernel's
2140 * __ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will2140 * __ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will
2141 * be overwritten by kernel.2141 * be overwritten by kernel.
2142 * @supported: Bitmap with each bit meaning given by
2143 * %ethtool_link_mode_bit_indices for the link modes, physical
2144 * connectors and other link features for which the interface
2145 * supports autonegotiation or auto-detection. Read-only.
2146 * @advertising: Bitmap with each bit meaning given by
2147 * %ethtool_link_mode_bit_indices for the link modes, physical
2148 * connectors and other link features that are advertised through
2149 * autonegotiation or enabled for auto-detection.
2150 * @lp_advertising: Bitmap with each bit meaning given by
2151 * %ethtool_link_mode_bit_indices for the link modes, and other
2152 * link features that the link partner advertised through
2153 * autonegotiation; 0 if unknown or not applicable. Read-only.
2154 * @transceiver: Used to distinguish different possible PHY types,2142 * @transceiver: Used to distinguish different possible PHY types,
2155 * reported consistently by PHYLIB. Read-only.2143 * reported consistently by PHYLIB. Read-only.
2156 * @master_slave_cfg: Master/slave port mode.2144 * @master_slave_cfg: Master/slave port mode.
@@ -2192,6 +2180,21 @@ enum ethtool_reset_flags { · 35 unmodified lines
2192 * %set_link_ksettings() should validate all fields other than @cmd2180 * %set_link_ksettings() should validate all fields other than @cmd
2193 * and @link_mode_masks_nwords that are not described as read-only or2181 * and @link_mode_masks_nwords that are not described as read-only or
2194 * deprecated, and must ignore all fields described as read-only.2182 * deprecated, and must ignore all fields described as read-only.
2183 *
2184 * @link_mode_masks is divided into three bitfields, each of length
2185 * @link_mode_masks_nwords:
2186 * - supported: Bitmap with each bit meaning given by
2187 * %ethtool_link_mode_bit_indices for the link modes, physical
2188 * connectors and other link features for which the interface
2189 * supports autonegotiation or auto-detection. Read-only.
2190 * - advertising: Bitmap with each bit meaning given by
2191 * %ethtool_link_mode_bit_indices for the link modes, physical
2192 * connectors and other link features that are advertised through
2193 * autonegotiation or enabled for auto-detection.
2194 * - lp_advertising: Bitmap with each bit meaning given by
2195 * %ethtool_link_mode_bit_indices for the link modes, and other
2196 * link features that the link partner advertised through
2197 * autonegotiation; 0 if unknown or not applicable. Read-only.
2195 */2198 */
2196struct ethtool_link_settings {2199struct ethtool_link_settings {
2197 __u32 cmd;2200 __u32 cmd;