From: Ivan Malov Date: Fri, 11 May 2018 14:05:51 +0000 (+0100) Subject: ethdev: improve doc for name by port ID API X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=2d65bf3cfb1bb6063476a078ab43b60cac6cbfa7;p=dpdk.git 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 Signed-off-by: Andrew Rybchenko Reviewed-by: Ferruh Yigit --- diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h index 7ecccf0147..f8815e9949 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.