doc: postpone deprecation of pipeline legacy API

Message ID 20230719151225.1658316-1-cristian.dumitrescu@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: postpone deprecation of pipeline legacy API |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-abi-testing success Testing PASS
ci/iol-aarch-unit-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-unit-testing fail Testing issues
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS

Commit Message

Cristian Dumitrescu July 19, 2023, 3:12 p.m. UTC
  Postpone the deprecation of the legacy pipeline, table and port
library API and gradual stabilization of the new API.

Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 21 +++++++++------------
 1 file changed, 9 insertions(+), 12 deletions(-)
  

Comments

Bruce Richardson July 19, 2023, 4:08 p.m. UTC | #1
On Wed, Jul 19, 2023 at 03:12:25PM +0000, Cristian Dumitrescu wrote:
> Postpone the deprecation of the legacy pipeline, table and port
> library API and gradual stabilization of the new API.
> 
> Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 21 +++++++++------------
>  1 file changed, 9 insertions(+), 12 deletions(-)
>

No objection to this, though it would be really good to get the new
functions stabilized in 23.11 when we lock down the 24 ABI.

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index fb771a0305..56ef906cdb 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -145,19 +145,16 @@ Deprecation Notices
>    In the absence of such interest, this library will be removed in DPDK 23.11.
>  
>  * pipeline: The pipeline library legacy API (functions rte_pipeline_*)
> -  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11 release.
> -  The new pipeline library API (functions rte_swx_pipeline_*)
> -  will gradually transition from experimental to stable status
> -  starting with DPDK 23.07 release.
> +  will be deprecated and subsequently removed in DPDK 24.11 release.
> +  Before this, the new pipeline library API (functions rte_swx_pipeline_*)
> +  will gradually transition from experimental to stable status.
>  
>  * table: The table library legacy API (functions rte_table_*)
> -  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11 release.
> -  The new table library API (functions rte_swx_table_*)
> -  will gradually transition from experimental to stable status
> -  starting with DPDK 23.07 release.
> +  will be deprecated and subsequently removed in DPDK 24.11 release.
> +  Before this, the new table library API (functions rte_swx_table_*)
> +  will gradually transition from experimental to stable status.
>  
>  * port: The port library legacy API (functions rte_port_*)
> -  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11 release.
> -  The new port library API (functions rte_swx_port_*)
> -  will gradually transition from experimental to stable status
> -  starting with DPDK 23.07 release.
> +  will be deprecated and subsequently removed in DPDK 24.11 release.
> +  Before this, the new port library API (functions rte_swx_port_*)
> +  will gradually transition from experimental to stable status.
> -- 
> 2.34.1
>
  
Suresh Narayane, Harshad July 20, 2023, 6:12 a.m. UTC | #2
-----Original Message-----
From: Dumitrescu, Cristian <cristian.dumitrescu@intel.com> 
Sent: Wednesday, July 19, 2023 8:42 PM
To: dev@dpdk.org
Cc: Richardson, Bruce <bruce.richardson@intel.com>; Nicolau, Radu <radu.nicolau@intel.com>; R, Kamalakannan <kamalakannan.r@intel.com>; Suresh Narayane, Harshad <harshad.suresh.narayane@intel.com>
Subject: [PATCH] doc: postpone deprecation of pipeline legacy API

Postpone the deprecation of the legacy pipeline, table and port library API and gradual stabilization of the new API.

Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 21 +++++++++------------
 1 file changed, 9 insertions(+), 12 deletions(-)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index fb771a0305..56ef906cdb 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -145,19 +145,16 @@ Deprecation Notices
   In the absence of such interest, this library will be removed in DPDK 23.11.
 
 * pipeline: The pipeline library legacy API (functions rte_pipeline_*)
-  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11 release.
-  The new pipeline library API (functions rte_swx_pipeline_*)
-  will gradually transition from experimental to stable status
-  starting with DPDK 23.07 release.
+  will be deprecated and subsequently removed in DPDK 24.11 release.
+  Before this, the new pipeline library API (functions 
+ rte_swx_pipeline_*)  will gradually transition from experimental to stable status.
 
 * table: The table library legacy API (functions rte_table_*)
-  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11 release.
-  The new table library API (functions rte_swx_table_*)
-  will gradually transition from experimental to stable status
-  starting with DPDK 23.07 release.
+  will be deprecated and subsequently removed in DPDK 24.11 release.
+  Before this, the new table library API (functions rte_swx_table_*)  
+ will gradually transition from experimental to stable status.
 
 * port: The port library legacy API (functions rte_port_*)
-  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11 release.
-  The new port library API (functions rte_swx_port_*)
-  will gradually transition from experimental to stable status
-  starting with DPDK 23.07 release.
+  will be deprecated and subsequently removed in DPDK 24.11 release.
+  Before this, the new port library API (functions rte_swx_port_*)  
+ will gradually transition from experimental to stable status.
--
2.34.1

Acked-by: Harshad Narayane <harshad.suresh.narayane@intel.com>
  
Radu Nicolau July 20, 2023, 8:18 a.m. UTC | #3
On 19-Jul-23 4:12 PM, Cristian Dumitrescu wrote:
> Postpone the deprecation of the legacy pipeline, table and port
> library API and gradual stabilization of the new API.
>
> Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> ---

Acked-by: Radu Nicolau <radu.nicolau@intel.com>
  
Cristian Dumitrescu July 20, 2023, 10:37 a.m. UTC | #4
> -----Original Message-----
> From: Richardson, Bruce <bruce.richardson@intel.com>
> Sent: Wednesday, July 19, 2023 5:09 PM
> To: Dumitrescu, Cristian <cristian.dumitrescu@intel.com>
> Cc: dev@dpdk.org; Nicolau, Radu <radu.nicolau@intel.com>; R,
> Kamalakannan <kamalakannan.r@intel.com>; Suresh Narayane, Harshad
> <harshad.suresh.narayane@intel.com>
> Subject: Re: [PATCH] doc: postpone deprecation of pipeline legacy API
> 
> On Wed, Jul 19, 2023 at 03:12:25PM +0000, Cristian Dumitrescu wrote:
> > Postpone the deprecation of the legacy pipeline, table and port
> > library API and gradual stabilization of the new API.
> >
> > Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 21 +++++++++------------
> >  1 file changed, 9 insertions(+), 12 deletions(-)
> >
> 
> No objection to this, though it would be really good to get the new
> functions stabilized in 23.11 when we lock down the 24 ABI.
> 

Yes, fully agree, let's see if we can make this happen for 23.11

> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> 
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> > index fb771a0305..56ef906cdb 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -145,19 +145,16 @@ Deprecation Notices
> >    In the absence of such interest, this library will be removed in DPDK 23.11.
> >
> >  * pipeline: The pipeline library legacy API (functions rte_pipeline_*)
> > -  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11
> release.
> > -  The new pipeline library API (functions rte_swx_pipeline_*)
> > -  will gradually transition from experimental to stable status
> > -  starting with DPDK 23.07 release.
> > +  will be deprecated and subsequently removed in DPDK 24.11 release.
> > +  Before this, the new pipeline library API (functions rte_swx_pipeline_*)
> > +  will gradually transition from experimental to stable status.
> >
> >  * table: The table library legacy API (functions rte_table_*)
> > -  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11
> release.
> > -  The new table library API (functions rte_swx_table_*)
> > -  will gradually transition from experimental to stable status
> > -  starting with DPDK 23.07 release.
> > +  will be deprecated and subsequently removed in DPDK 24.11 release.
> > +  Before this, the new table library API (functions rte_swx_table_*)
> > +  will gradually transition from experimental to stable status.
> >
> >  * port: The port library legacy API (functions rte_port_*)
> > -  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11
> release.
> > -  The new port library API (functions rte_swx_port_*)
> > -  will gradually transition from experimental to stable status
> > -  starting with DPDK 23.07 release.
> > +  will be deprecated and subsequently removed in DPDK 24.11 release.
> > +  Before this, the new port library API (functions rte_swx_port_*)
> > +  will gradually transition from experimental to stable status.
> > --
> > 2.34.1
> >
  
Thomas Monjalon July 28, 2023, 4:02 p.m. UTC | #5
> > > Postpone the deprecation of the legacy pipeline, table and port
> > > library API and gradual stabilization of the new API.
> > >
> > > Signed-off-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>
> > > ---
> > >  doc/guides/rel_notes/deprecation.rst | 21 +++++++++------------
> > >  1 file changed, 9 insertions(+), 12 deletions(-)
> > >
> > 
> > No objection to this, though it would be really good to get the new
> > functions stabilized in 23.11 when we lock down the 24 ABI.
> > 
> 
> Yes, fully agree, let's see if we can make this happen for 23.11
> 
> > Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index fb771a0305..56ef906cdb 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -145,19 +145,16 @@  Deprecation Notices
   In the absence of such interest, this library will be removed in DPDK 23.11.
 
 * pipeline: The pipeline library legacy API (functions rte_pipeline_*)
-  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11 release.
-  The new pipeline library API (functions rte_swx_pipeline_*)
-  will gradually transition from experimental to stable status
-  starting with DPDK 23.07 release.
+  will be deprecated and subsequently removed in DPDK 24.11 release.
+  Before this, the new pipeline library API (functions rte_swx_pipeline_*)
+  will gradually transition from experimental to stable status.
 
 * table: The table library legacy API (functions rte_table_*)
-  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11 release.
-  The new table library API (functions rte_swx_table_*)
-  will gradually transition from experimental to stable status
-  starting with DPDK 23.07 release.
+  will be deprecated and subsequently removed in DPDK 24.11 release.
+  Before this, the new table library API (functions rte_swx_table_*)
+  will gradually transition from experimental to stable status.
 
 * port: The port library legacy API (functions rte_port_*)
-  will be deprecated in DPDK 23.07 release and removed in DPDK 23.11 release.
-  The new port library API (functions rte_swx_port_*)
-  will gradually transition from experimental to stable status
-  starting with DPDK 23.07 release.
+  will be deprecated and subsequently removed in DPDK 24.11 release.
+  Before this, the new port library API (functions rte_swx_port_*)
+  will gradually transition from experimental to stable status.