diff mbox

[dpdk-dev,v2] ethdev: update description for functions

Message ID 1526620373-122738-1-git-send-email-vipin.varghese@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Varghese, Vipin May 18, 2018, 5:12 a.m. UTC 
  Change adds extra information on name parameter for API
rte_eth_dev_get_name_by_port and rte_eth_dev_get_port_by_name.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---
 lib/librte_ethdev/rte_ethdev.h | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

Comments

Ferruh Yigit May 21, 2018, 3:15 p.m. UTC | #1 
On 5/18/2018 6:12 AM, Vipin Varghese wrote:
> Change adds extra information on name parameter for API
> rte_eth_dev_get_name_by_port and rte_eth_dev_get_port_by_name.
> 
> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Ferruh Yigit May 21, 2018, 3:16 p.m. UTC | #2 
On 5/21/2018 4:15 PM, Ferruh Yigit wrote:
> On 5/18/2018 6:12 AM, Vipin Varghese wrote:
>> Change adds extra information on name parameter for API
>> rte_eth_dev_get_name_by_port and rte_eth_dev_get_port_by_name.
>>
>> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> 
> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied to dpdk-next-net/master, thanks.
diff mbox

Patch

diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index f8815e9..66463a9 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -3657,7 +3657,10 @@  rte_eth_dev_l2_tunnel_offload_set(uint16_t port_id,
 
 /**
 * Get the port id from pci address or device name
-* Ex: 0000:2:00.0 or vdev name net_pcap0
+* Ex:
+* - PCIe, 0000:2:00.0
+* - SoC, fsl-gmac0
+* - vdev, net_pcap0
 *
 * @param name
 *  pci address or name of the device
@@ -3672,6 +3675,10 @@  rte_eth_dev_get_port_by_name(const char *name, uint16_t *port_id);
 
 /**
 * Get the device name from port id
+* Ex:
+* - PCIe Bus:Domian:Function, 0000:02:00.0
+* - SoC device name, fsl-gmac0
+* - vdev dpdk name, net_[pcap0|null0|tun0|tap0]
 *
 * @param port_id
 *   Port identifier of the device.