Patchwork [dpdk-dev] ethdev: declare tx prepare api as not experimental

login
register
mail settings
Submitter David Marchand
Date Jan. 11, 2019, 1:14 p.m.
Message ID <1547212498-14999-1-git-send-email-david.marchand@redhat.com>
Download mbox | patch
Permalink /patch/697671/
State New
Headers show

Comments

David Marchand - Jan. 11, 2019, 1:14 p.m.
The tx prepare api was introduced at a time when the experimental api
tag mechanism did not exist yet and is missing the tag.
However, this api has been there since 17.02 and did not suffer any
change since its introduction.

Let's just remove the warning from the documentation.

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
This has been caught while reviewing the tso support in ovs.
There seems to be a lot of other incorrectly documentated apis like
this...
I will see if I can find an easy way to identify them.
---
 lib/librte_ethdev/rte_ethdev.h | 3 ---
 1 file changed, 3 deletions(-)
Ferruh Yigit - Jan. 11, 2019, 1:30 p.m.
On 1/11/2019 1:14 PM, David Marchand wrote:
> The tx prepare api was introduced at a time when the experimental api
> tag mechanism did not exist yet and is missing the tag.
> However, this api has been there since 17.02 and did not suffer any
> change since its introduction.
> 
> Let's just remove the warning from the documentation.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

cc'ed Konstantin.
Andrew Rybchenko - Jan. 11, 2019, 1:32 p.m.
On 1/11/19 4:14 PM, David Marchand wrote:
> The tx prepare api was introduced at a time when the experimental api
> tag mechanism did not exist yet and is missing the tag.
> However, this api has been there since 17.02 and did not suffer any
> change since its introduction.
>
> Let's just remove the warning from the documentation.
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>

with few nits: tx -> Tx, api -> API
Ananyev, Konstantin - Jan. 11, 2019, 1:53 p.m.
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of David Marchand
> Sent: Friday, January 11, 2019 1:15 PM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; Yigit, Ferruh <ferruh.yigit@intel.com>; arybchenko@solarflare.com
> Subject: [dpdk-dev] [PATCH] ethdev: declare tx prepare api as not experimental
> 
> The tx prepare api was introduced at a time when the experimental api
> tag mechanism did not exist yet and is missing the tag.
> However, this api has been there since 17.02 and did not suffer any
> change since its introduction.
> 
> Let's just remove the warning from the documentation.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> This has been caught while reviewing the tso support in ovs.
> There seems to be a lot of other incorrectly documentated apis like
> this...
> I will see if I can find an easy way to identify them.
> ---
>  lib/librte_ethdev/rte_ethdev.h | 3 ---
>  1 file changed, 3 deletions(-)
> 
> diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
> index 1960f3a..76266ad 100644
> --- a/lib/librte_ethdev/rte_ethdev.h
> +++ b/lib/librte_ethdev/rte_ethdev.h
> @@ -4159,9 +4159,6 @@ static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
>  }
> 
>  /**
> - * @warning
> - * @b EXPERIMENTAL: this API may change without prior notice
> - *
>   * Process a burst of output packets on a transmit queue of an Ethernet device.
>   *
>   * The rte_eth_tx_prepare() function is invoked to prepare output packets to be
> --

Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>

> 1.8.3.1

Patch

diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index 1960f3a..76266ad 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -4159,9 +4159,6 @@  static inline int rte_eth_tx_descriptor_status(uint16_t port_id,
 }
 
 /**
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  * Process a burst of output packets on a transmit queue of an Ethernet device.
  *
  * The rte_eth_tx_prepare() function is invoked to prepare output packets to be