diff mbox series

[v4,01/19] ethdev: reword dev_info_get description.

Message ID 20230222162539.127103-2-stephen@networkplumber.org (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series Remove repeated words in comments and messages |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Stephen Hemminger Feb. 22, 2023, 4:25 p.m. UTC 
  The original comment was redundant and had duplicate word 'of'.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 lib/ethdev/rte_ethdev.h | 32 ++++----------------------------
 1 file changed, 4 insertions(+), 28 deletions(-)
diff mbox series

Patch

diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
index 049641d57c66..14b8fa8402f1 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -3275,34 +3275,10 @@  int rte_eth_macaddrs_get(uint16_t port_id, struct rte_ether_addr *ma,
 /**
  * Retrieve the contextual information of an Ethernet device.
  *
- * As part of this function, a number of of fields in dev_info will be
- * initialized as follows:
- *
- * rx_desc_lim = lim
- * tx_desc_lim = lim
- *
- * Where lim is defined within the rte_eth_dev_info_get as
- *
- *  const struct rte_eth_desc_lim lim = {
- *      .nb_max = UINT16_MAX,
- *      .nb_min = 0,
- *      .nb_align = 1,
- *	.nb_seg_max = UINT16_MAX,
- *	.nb_mtu_seg_max = UINT16_MAX,
- *  };
- *
- * device = dev->device
- * min_mtu = RTE_ETHER_MIN_LEN - RTE_ETHER_HDR_LEN - RTE_ETHER_CRC_LEN
- * max_mtu = UINT16_MAX
- *
- * The following fields will be populated if support for dev_infos_get()
- * exists for the device and the rte_eth_dev 'dev' has been populated
- * successfully with a call to it:
- *
- * driver_name = rte_driver_name(rte_dev_driver(dev->device));
- * nb_rx_queues = dev->data->nb_rx_queues
- * nb_tx_queues = dev->data->nb_tx_queues
- * dev_flags = &dev->data->dev_flags
+ * This function returns the Ethernet device information based
+ * on the values stored internally in the device specific data.
+ * For example: number of queues, descriptor limits, device
+ * capabilities and offload flags.
  *
  * @param port_id
  *   The port identifier of the Ethernet device.