[V3] doc: announce the pipeline legacy API deprecation

Message ID 20230309200949.847639-1-cristian.dumitrescu@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [V3] doc: announce the pipeline legacy API deprecation |

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 fail Testing issues
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing fail Testing issues
ci/iol-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Cristian Dumitrescu March 9, 2023, 8:09 p.m. UTC
  Announce 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 | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
  

Comments

Suresh Narayane, Harshad March 10, 2023, 6:02 a.m. UTC | #1
-----Original Message-----
From: Dumitrescu, Cristian <cristian.dumitrescu@intel.com> 
Sent: Friday, March 10, 2023 1:40 AM
To: dev@dpdk.org
Cc: R, Kamalakannan <kamalakannan.r@intel.com>; Jangra, Yogesh <yogesh.jangra@intel.com>; Suresh Narayane, Harshad <harshad.suresh.narayane@intel.com>
Subject: [PATCH V3] doc: announce the pipeline legacy API deprecation

Announce 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 | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 872847e938..66f2329b9c 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -135,3 +135,21 @@ Deprecation Notices
   Its removal has been postponed to let potential users report interest
   in maintaining it.
   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.
+
+* 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.
+
+* 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.
--
2.34.1

Acked-by: Harshad Narayane <harshad.suresh.narayane@intel.com>
  
Yogesh Jangra March 10, 2023, 7:25 a.m. UTC | #2
Thanks & Regards,
Yogesh Jangra

-----Original Message-----
From: Dumitrescu, Cristian <cristian.dumitrescu@intel.com> 
Sent: Friday, March 10, 2023 1:40 AM
To: dev@dpdk.org
Cc: R, Kamalakannan <kamalakannan.r@intel.com>; Jangra, Yogesh <yogesh.jangra@intel.com>; Suresh Narayane, Harshad <harshad.suresh.narayane@intel.com>
Subject: [PATCH V3] doc: announce the pipeline legacy API deprecation

Announce 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 | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 872847e938..66f2329b9c 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -135,3 +135,21 @@ Deprecation Notices
   Its removal has been postponed to let potential users report interest
   in maintaining it.
   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.
+
+* 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.
+
+* 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.
--
2.34.1

Acked-by: Yogesh Jangra <yogesh.jangra@intel.com>
  
Bruce Richardson March 10, 2023, 9:57 a.m. UTC | #3
On Thu, Mar 09, 2023 at 08:09:49PM +0000, Cristian Dumitrescu wrote:
> Announce 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>

Presumably the marking the new APIs as stable shouldn't need to be
"grandual", as we need stable replacements before deprecating any old
functions. However, since that seems to be covered here:

Acked-by: Bruce Richardson <bruce.richardson@intel.com>

> ---
>  doc/guides/rel_notes/deprecation.rst | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 872847e938..66f2329b9c 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -135,3 +135,21 @@ Deprecation Notices
>    Its removal has been postponed to let potential users report interest
>    in maintaining it.
>    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.
> +
> +* 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.
> +
> +* 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.
> -- 
> 2.34.1
>
  
Radu Nicolau March 10, 2023, 9:58 a.m. UTC | #4
On 3/9/2023 8:09 PM, Cristian Dumitrescu wrote:
> Announce 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 | 18 ++++++++++++++++++
>   1 file changed, 18 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 872847e938..66f2329b9c 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -135,3 +135,21 @@ Deprecation Notices
>     Its removal has been postponed to let potential users report interest
>     in maintaining it.
>     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.
> +
> +* 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.
> +
> +* 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.


Acked-by: Radu Nicolau <radu.nicolau@intel.com>
  
Kamalakannan R March 10, 2023, 12:19 p.m. UTC | #5
-----Original Message-----
From: Dumitrescu, Cristian <cristian.dumitrescu@intel.com> 
Sent: Friday, March 10, 2023 1:40 AM
To: dev@dpdk.org
Cc: R, Kamalakannan <kamalakannan.r@intel.com>; Jangra, Yogesh <yogesh.jangra@intel.com>; Suresh Narayane, Harshad <harshad.suresh.narayane@intel.com>
Subject: [PATCH V3] doc: announce the pipeline legacy API deprecation

Announce 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 | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 872847e938..66f2329b9c 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -135,3 +135,21 @@ Deprecation Notices
   Its removal has been postponed to let potential users report interest
   in maintaining it.
   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.
+
+* 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.
+
+* 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.
--
2.34.1

Acked-by: Kamalakannan R <kamalakannan.r@intel.com>
  
Thomas Monjalon March 31, 2023, 1:20 p.m. UTC | #6
09/03/2023 21:09, Cristian Dumitrescu:
> Announce 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>

We'll discuss the timeline for promoting the new API,
when reviewing the patches.
As Bruce suggest, I anticipate it should be the first thing to do.

Applied, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 872847e938..66f2329b9c 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -135,3 +135,21 @@  Deprecation Notices
   Its removal has been postponed to let potential users report interest
   in maintaining it.
   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.
+
+* 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.
+
+* 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.