diff mbox

[dpdk-dev] ethdev: update description for functions

Message ID 1526554742-117308-1-git-send-email-vipin.varghese@intel.com (mailing list archive)
State Superseded, 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 17, 2018, 10:59 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 17, 2018, 12:32 p.m. UTC | #1 
On 5/17/2018 11:59 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>
> ---
>  lib/librte_ethdev/rte_ethdev.h | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
> 
> diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
> index f8815e9..7387686 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, fslgmac0
> +* - vdev driver name, net_pcap0

driver name is "net_pcap", device name is "net_pcap0".
Original "vdev name" seems more accurate, is there a reason to change it to
"driver name"?

>  *
>  * @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:

What do you think say "Ex device name:" here and remove "device name" from below:
PCIe, 0000:02:00.0
SoC, fslgmac0
vdev, net_pcap0, net_null0, net_tun0 or net_tap0, ...

> +* - PCIe Bus:Domian:Function, 0000:02:00.0
> +* - SoC device name, fslgmac0
> +* - VDEV driver name, net_pcap0, net_null0, net_tun0 or net_tap0

Why VDEV capitalized?

>  *
>  * @param port_id
>  *   Port identifier of the device.
>
Varghese, Vipin May 18, 2018, 5:03 a.m. UTC | #2 
Thanks you for the corrections, I had sent the diff from the wrong folder. Will be sending out V2 for the corrected one.

> -----Original Message-----

> From: Yigit, Ferruh

> Sent: Thursday, May 17, 2018 6:03 PM

> To: Varghese, Vipin <vipin.varghese@intel.com>; dev@dpdk.org; Mcnamara,

> John <john.mcnamara@intel.com>; Daly, Lee <lee.daly@intel.com>; Jain,

> Deepak K <deepak.k.jain@intel.com>

> Subject: Re: [dpdk-dev] [PATCH] ethdev: update description for functions

> 

> On 5/17/2018 11:59 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>

> > ---

> >  lib/librte_ethdev/rte_ethdev.h | 9 ++++++++-

> >  1 file changed, 8 insertions(+), 1 deletion(-)

> >

> > diff --git a/lib/librte_ethdev/rte_ethdev.h

> > b/lib/librte_ethdev/rte_ethdev.h index f8815e9..7387686 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, fslgmac0

> > +* - vdev driver name, net_pcap0

> 

> driver name is "net_pcap", device name is "net_pcap0".

> Original "vdev name" seems more accurate, is there a reason to change it to

> "driver name"?

> 

> >  *

> >  * @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:

> 

> What do you think say "Ex device name:" here and remove "device name" from

> below:

> PCIe, 0000:02:00.0

> SoC, fslgmac0

> vdev, net_pcap0, net_null0, net_tun0 or net_tap0, ...

> 

> > +* - PCIe Bus:Domian:Function, 0000:02:00.0

> > +* - SoC device name, fslgmac0

> > +* - VDEV driver name, net_pcap0, net_null0, net_tun0 or net_tap0

> 

> Why VDEV capitalized?

> 

> >  *

> >  * @param port_id

> >  *   Port identifier of the device.

> >
diff mbox

Patch

diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index f8815e9..7387686 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, fslgmac0
+* - vdev driver name, 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, fslgmac0
+* - VDEV driver name, net_pcap0, net_null0, net_tun0 or net_tap0
 *
 * @param port_id
 *   Port identifier of the device.