summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Malov <ivan.malov@oktetlabs.ru>2018-05-11 15:05:51 +0100
committerFerruh Yigit <ferruh.yigit@intel.com>2018-05-14 22:32:22 +0100
commit2d65bf3cfb1bb6063476a078ab43b60cac6cbfa7 (patch)
treebdb6f77ea3d421097712abf68ef0249549c7604c
parent266c467f60f14feaa1d6ff56a302978bdf7eff60 (diff)
downloaddpdk-2d65bf3cfb1bb6063476a078ab43b60cac6cbfa7.zip
dpdk-2d65bf3cfb1bb6063476a078ab43b60cac6cbfa7.tar.gz
dpdk-2d65bf3cfb1bb6063476a078ab43b60cac6cbfa7.tar.xz
ethdev: improve doc for name by port ID API
Description of rte_eth_dev_get_name_by_port() calls port ID argument a pointer, which is misleading. Also, output buffer minimal size is not mentioned. These points need to be improved. Fixes: bde516d5a85a ("ethdev: get port by name") Cc: stable@dpdk.org Signed-off-by: Ivan Malov <ivan.malov@oktetlabs.ru> Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
-rw-r--r--lib/librte_ethdev/rte_ethdev.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index 7ecccf0..f8815e9 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -3674,9 +3674,9 @@ rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
* Get the device name from port id
*
* @param port_id
-* pointer to port identifier of the device
+* Port identifier of the device.
* @param name
-* pci address or name of the device
+* Buffer of size RTE_ETH_NAME_MAX_LEN to store the name.
* @return
* - (0) if successful.
* - (-EINVAL) on failure.