[dpdk-dev] doc: update deprecation of ethdev offload API

Message ID 20171017142414.127705-1-shahafs@mellanox.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

Shahaf Shuler Oct. 17, 2017, 2:24 p.m. UTC
  Update deprecation notice for the new ethdev offloads API.
Deprecation of the old offloads API is set to 18.05.

Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
---
 doc/guides/rel_notes/deprecation.rst | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)
  

Comments

Shahaf Shuler Oct. 25, 2017, 10:49 a.m. UTC | #1
Hi,

Any comments on this patch? Is there any objection to deprecation in 18.05? 

Tuesday, October 17, 2017 5:24 PM, Shahaf Shuler:
> Update deprecation notice for the new ethdev offloads API.
> Deprecation of the old offloads API is set to 18.05.
> 
> Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 14 ++++++++------
>  1 file changed, 8 insertions(+), 6 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 52058f580..deb546a67 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -41,12 +41,14 @@ Deprecation Notices
>    PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
>    their behavior will be kept until 17.08 and will be removed in 17.11.
> 
> -* ethdev: Tx offloads will no longer be enabled by default in 17.11.
> -  Instead, the ``rte_eth_txmode`` structure will be extended with
> -  bit field to enable each Tx offload.
> -  Besides of making the Rx/Tx configuration API more consistent for the
> -  application, PMDs will be able to provide a better out of the box
> performance.
> -  As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
> +* ethdev: a new Tx and Rx offload API was introduced on 17.11.
> +  In the new API, offloads are divided into per-port and per-queue offloads.
> +  Offloads are disabled by default and enabled per application request.
> +  The old offloads API is target to be deprecated on 18.05. This includes:
> +
> +  - removal of ``ETH_TXQ_FLAGS_NO*`` flags.
> +  - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct.
> +  - removal of the offloads bit-field from ``rte_eth_rxmode`` struct.
> 
>  * ethdev: the legacy filter API, including
>    ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
> --
> 2.12.0
  
Andrew Rybchenko Nov. 8, 2017, 11:16 a.m. UTC | #2
On 10/17/2017 05:24 PM, Shahaf Shuler wrote:
> Update deprecation notice for the new ethdev offloads API.
> Deprecation of the old offloads API is set to 18.05.
>
> Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 14 ++++++++------
>   1 file changed, 8 insertions(+), 6 deletions(-)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 52058f580..deb546a67 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -41,12 +41,14 @@ Deprecation Notices
>     PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
>     their behavior will be kept until 17.08 and will be removed in 17.11.
>   
> -* ethdev: Tx offloads will no longer be enabled by default in 17.11.
> -  Instead, the ``rte_eth_txmode`` structure will be extended with
> -  bit field to enable each Tx offload.
> -  Besides of making the Rx/Tx configuration API more consistent for the
> -  application, PMDs will be able to provide a better out of the box performance.
> -  As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
> +* ethdev: a new Tx and Rx offload API was introduced on 17.11.
> +  In the new API, offloads are divided into per-port and per-queue offloads.
> +  Offloads are disabled by default and enabled per application request.
> +  The old offloads API is target to be deprecated on 18.05. This includes:
> +
> +  - removal of ``ETH_TXQ_FLAGS_NO*`` flags.
> +  - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct.
> +  - removal of the offloads bit-field from ``rte_eth_rxmode`` struct.
>   
>   * ethdev: the legacy filter API, including
>     ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
  
Ananyev, Konstantin Nov. 10, 2017, 4:41 p.m. UTC | #3
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Shahaf Shuler
> Sent: Tuesday, October 17, 2017 3:24 PM
> To: nhorman@tuxdriver.com; thomas@monjalon.net
> Cc: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: update deprecation of ethdev offload API
> 
> Update deprecation notice for the new ethdev offloads API.
> Deprecation of the old offloads API is set to 18.05.
> 
> Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 14 ++++++++------
>  1 file changed, 8 insertions(+), 6 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 52058f580..deb546a67 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -41,12 +41,14 @@ Deprecation Notices
>    PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
>    their behavior will be kept until 17.08 and will be removed in 17.11.
> 
> -* ethdev: Tx offloads will no longer be enabled by default in 17.11.
> -  Instead, the ``rte_eth_txmode`` structure will be extended with
> -  bit field to enable each Tx offload.
> -  Besides of making the Rx/Tx configuration API more consistent for the
> -  application, PMDs will be able to provide a better out of the box performance.
> -  As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
> +* ethdev: a new Tx and Rx offload API was introduced on 17.11.
> +  In the new API, offloads are divided into per-port and per-queue offloads.
> +  Offloads are disabled by default and enabled per application request.
> +  The old offloads API is target to be deprecated on 18.05. This includes:
> +
> +  - removal of ``ETH_TXQ_FLAGS_NO*`` flags.
> +  - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct.
> +  - removal of the offloads bit-field from ``rte_eth_rxmode`` struct.
> 
>  * ethdev: the legacy filter API, including
>    ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
> --

Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> 2.12.0
  
Thomas Monjalon Nov. 12, 2017, 4:19 a.m. UTC | #4
> > Update deprecation notice for the new ethdev offloads API.
> > Deprecation of the old offloads API is set to 18.05.
> > 
> > Signed-off-by: Shahaf Shuler <shahafs@mellanox.com>
> 
> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied, thanks
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 52058f580..deb546a67 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -41,12 +41,14 @@  Deprecation Notices
   PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
   their behavior will be kept until 17.08 and will be removed in 17.11.
 
-* ethdev: Tx offloads will no longer be enabled by default in 17.11.
-  Instead, the ``rte_eth_txmode`` structure will be extended with
-  bit field to enable each Tx offload.
-  Besides of making the Rx/Tx configuration API more consistent for the
-  application, PMDs will be able to provide a better out of the box performance.
-  As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
+* ethdev: a new Tx and Rx offload API was introduced on 17.11.
+  In the new API, offloads are divided into per-port and per-queue offloads.
+  Offloads are disabled by default and enabled per application request.
+  The old offloads API is target to be deprecated on 18.05. This includes:
+
+  - removal of ``ETH_TXQ_FLAGS_NO*`` flags.
+  - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct.
+  - removal of the offloads bit-field from ``rte_eth_rxmode`` struct.
 
 * ethdev: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well