ethdev: improve doc for name by port ID API
authorIvan Malov <ivan.malov@oktetlabs.ru>
Fri, 11 May 2018 14:05:51 +0000 (15:05 +0100)
committerFerruh Yigit <ferruh.yigit@intel.com>
Mon, 14 May 2018 21:32:22 +0000 (22:32 +0100)
commit2d65bf3cfb1bb6063476a078ab43b60cac6cbfa7
treebdb6f77ea3d421097712abf68ef0249549c7604c
parent266c467f60f14feaa1d6ff56a302978bdf7eff60
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>
lib/librte_ethdev/rte_ethdev.h