History

ethtool: document the enum values not defines

kdoc does not have good support for documenting defines, and we can't abuse the enum documentation because it generates warnings.

Jakub Kicinski committed 5 years ago

Commit d04feec1 parent cf2cc0b1 file · +10 −10Browse files

Showing the changes to include/uapi (1 of 1 file). Show all

Unified · Split

include/uapi/linux/ethtool.h+10−10
@@ -1414,16 +1414,16 @@ struct ethtool_fecparam { · 1413 unmodified lines
1414 1414
1415/**1415/**
1416 * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration1416 * enum ethtool_fec_config_bits - flags definition of ethtool_fec_configuration
1417 * @ETHTOOL_FEC_NONE: FEC mode configuration is not supported. Should not1417 * @ETHTOOL_FEC_NONE_BIT: FEC mode configuration is not supported. Should not
1418 * be used together with other bits. GET only.1418 * be used together with other bits. GET only.
1419 * @ETHTOOL_FEC_AUTO: Select default/best FEC mode automatically, usually based1419 * @ETHTOOL_FEC_AUTO_BIT: Select default/best FEC mode automatically, usually
1420 * link mode and SFP parameters read from module's EEPROM.1420 * based link mode and SFP parameters read from module's
1421 * This bit does _not_ mean autonegotiation.1421 * EEPROM. This bit does _not_ mean autonegotiation.
1422 * @ETHTOOL_FEC_OFF: No FEC Mode1422 * @ETHTOOL_FEC_OFF_BIT: No FEC Mode
1423 * @ETHTOOL_FEC_RS: Reed-Solomon FEC Mode1423 * @ETHTOOL_FEC_RS_BIT: Reed-Solomon FEC Mode
1424 * @ETHTOOL_FEC_BASER: Base-R/Reed-Solomon FEC Mode1424 * @ETHTOOL_FEC_BASER_BIT: Base-R/Reed-Solomon FEC Mode
1425 * @ETHTOOL_FEC_LLRS: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet1425 * @ETHTOOL_FEC_LLRS_BIT: Low Latency Reed Solomon FEC Mode (25G/50G Ethernet
1426 * Consortium)1426 * Consortium)
1427 */1427 */
1428enum ethtool_fec_config_bits {1428enum ethtool_fec_config_bits {
1429 ETHTOOL_FEC_NONE_BIT,1429 ETHTOOL_FEC_NONE_BIT,