ethdev: fix doxygen comment for device info struct
Checks
Commit Message
API documentation for "struct rte_eth_dev_info" was missing some fields
'device' & 'max_hash_mac_addrs',
because of syntax error in doxygen comment, fixing it.
Bugzilla ID: 954
Fixes: 88ac4396ad29 ("ethdev: add VMDq support")
Fixes: cd8c7c7ce241 ("ethdev: replace bus specific struct with generic dev")
Cc: stable@dpdk.org
Reported-by: Bruce Merry <bmerry@sarao.ac.za>
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
lib/ethdev/rte_ethdev.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
Comments
08/03/2022 10:47, Ferruh Yigit:
> API documentation for "struct rte_eth_dev_info" was missing some fields
> 'device' & 'max_hash_mac_addrs',
> because of syntax error in doxygen comment, fixing it.
>
> Bugzilla ID: 954
> Fixes: 88ac4396ad29 ("ethdev: add VMDq support")
> Fixes: cd8c7c7ce241 ("ethdev: replace bus specific struct with generic dev")
> Cc: stable@dpdk.org
>
> Reported-by: Bruce Merry <bmerry@sarao.ac.za>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Applied, thanks.
@@ -1855,7 +1855,7 @@ enum rte_eth_representor_type {
* device, etc...
*/
struct rte_eth_dev_info {
- struct rte_device *device; /** Generic device information */
+ struct rte_device *device; /**< Generic device information */
const char *driver_name; /**< Device Driver name. */
unsigned int if_index; /**< Index to bound host interface, or 0 if none.
Use if_indextoname() to translate into an interface name. */
@@ -1869,8 +1869,8 @@ struct rte_eth_dev_info {
uint16_t max_rx_queues; /**< Maximum number of Rx queues. */
uint16_t max_tx_queues; /**< Maximum number of Tx queues. */
uint32_t max_mac_addrs; /**< Maximum number of MAC addresses. */
- uint32_t max_hash_mac_addrs;
/** Maximum number of hash MAC addresses for MTA and UTA. */
+ uint32_t max_hash_mac_addrs;
uint16_t max_vfs; /**< Maximum number of VFs. */
uint16_t max_vmdq_pools; /**< Maximum number of VMDq pools. */
struct rte_eth_rxseg_capa rx_seg_capa; /**< Segmentation capability.*/