Skip to content

Commit d0c3891

Browse files
Jonathan Corbetdavem330
authored andcommitted
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 <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Signed-off-by: David S. Miller <[email protected]>
1 parent 144377c commit d0c3891

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

include/uapi/linux/ethtool.h

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2139,18 +2139,6 @@ enum ethtool_reset_flags {
21392139
* refused. For drivers: ignore this field (use kernel's
21402140
* __ETHTOOL_LINK_MODE_MASK_NBITS instead), any change to it will
21412141
* 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.
21542142
* @transceiver: Used to distinguish different possible PHY types,
21552143
* reported consistently by PHYLIB. Read-only.
21562144
* @master_slave_cfg: Master/slave port mode.
@@ -2192,6 +2180,21 @@ enum ethtool_reset_flags {
21922180
* %set_link_ksettings() should validate all fields other than @cmd
21932181
* and @link_mode_masks_nwords that are not described as read-only or
21942182
* 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.
21952198
*/
21962199
struct ethtool_link_settings {
21972200
__u32 cmd;

0 commit comments

Comments
 (0)