* [dpdk-dev] [PATCH] ethdev: improve doc for name by port ID API
@ 2018-05-11 14:05 Andrew Rybchenko
2018-05-11 16:09 ` Ferruh Yigit
0 siblings, 1 reply; 3+ messages in thread
From: Andrew Rybchenko @ 2018-05-11 14:05 UTC (permalink / raw)
To: dev; +Cc: Ferruh Yigit, Thomas Monjalon, Ivan Malov, Reshma Pattan, stable
From: Ivan Malov <ivan.malov@oktetlabs.ru>
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: Reshma Pattan <reshma.pattan@intel.com>
Cc: stable@dpdk.org
Signed-off-by: Ivan Malov <ivan.malov@oktetlabs.ru>
Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
---
lib/librte_ethdev/rte_ethdev.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index 0bb14ff66..78e12bf5d 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -3670,9 +3670,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.
--
2.17.0
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [dpdk-dev] [PATCH] ethdev: improve doc for name by port ID API
2018-05-11 14:05 [dpdk-dev] [PATCH] ethdev: improve doc for name by port ID API Andrew Rybchenko
@ 2018-05-11 16:09 ` Ferruh Yigit
2018-05-11 16:12 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
0 siblings, 1 reply; 3+ messages in thread
From: Ferruh Yigit @ 2018-05-11 16:09 UTC (permalink / raw)
To: Andrew Rybchenko, dev; +Cc: Thomas Monjalon, Ivan Malov, Reshma Pattan, stable
On 5/11/2018 3:05 PM, Andrew Rybchenko wrote:
> From: Ivan Malov <ivan.malov@oktetlabs.ru>
>
> 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: Reshma Pattan <reshma.pattan@intel.com>
> 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>
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [dpdk-dev] [dpdk-stable] [PATCH] ethdev: improve doc for name by port ID API
2018-05-11 16:09 ` Ferruh Yigit
@ 2018-05-11 16:12 ` Ferruh Yigit
0 siblings, 0 replies; 3+ messages in thread
From: Ferruh Yigit @ 2018-05-11 16:12 UTC (permalink / raw)
To: Andrew Rybchenko, dev; +Cc: Thomas Monjalon, Ivan Malov, Reshma Pattan, stable
On 5/11/2018 5:09 PM, Ferruh Yigit wrote:
> On 5/11/2018 3:05 PM, Andrew Rybchenko wrote:
>> From: Ivan Malov <ivan.malov@oktetlabs.ru>
>>
>> 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: Reshma Pattan <reshma.pattan@intel.com>
>> 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>
Applied to dpdk-next-net/master, thanks.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2018-05-11 16:12 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-05-11 14:05 [dpdk-dev] [PATCH] ethdev: improve doc for name by port ID API Andrew Rybchenko
2018-05-11 16:09 ` Ferruh Yigit
2018-05-11 16:12 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).