doc: announce deprecation of flow copy function

Message ID 20180803143728.15817-1-adrien.mazarguil@6wind.com
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • doc: announce deprecation of flow copy function
Related show

Checks

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

Commit Message

Adrien Mazarguil Aug. 3, 2018, 2:37 p.m.
Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
Cc: Thomas Monjalon <thomas@monjalon.net>
Cc: Ferruh Yigit <ferruh.yigit@intel.com>
Cc: Gaetan Rivet <gaetan.rivet@6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Thomas Monjalon Aug. 5, 2018, 9:50 p.m. | #1
03/08/2018 16:37, Adrien Mazarguil:
> +* ethdev: flow API function ``rte_flow_copy()`` will be deprecated in v18.11
> +  in favor of ``rte_flow_conv()`` (which will appear in that version) and
> +  subsequently removed for v19.02.
> +
> +  This is due to a lack of flexibility and reliance on a type unusable with
> +  C++ programs (struct rte_flow_desc).

Acked-by: Thomas Monjalon <thomas@monjalon.net>
Maxime Coquelin Aug. 7, 2018, 2:35 p.m. | #2
On 08/03/2018 04:37 PM, Adrien Mazarguil wrote:
> Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>
> Cc: Ferruh Yigit <ferruh.yigit@intel.com>
> Cc: Gaetan Rivet <gaetan.rivet@6wind.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 7 +++++++
>   1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 14714fe94..05c77da65 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -68,3 +68,10 @@ Deprecation Notices
>     - ``rte_pdump_set_socket_dir`` will be removed;
>     - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
>     - The enum ``rte_pdump_socktype`` will be removed.
> +
> +* ethdev: flow API function ``rte_flow_copy()`` will be deprecated in v18.11
> +  in favor of ``rte_flow_conv()`` (which will appear in that version) and
> +  subsequently removed for v19.02.
> +
> +  This is due to a lack of flexibility and reliance on a type unusable with
> +  C++ programs (struct rte_flow_desc).
> 

Acked-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Jerin Jacob Aug. 8, 2018, 3:11 a.m. | #3
-----Original Message-----
> Date: Fri, 3 Aug 2018 16:37:52 +0200
> From: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> To: Neil Horman <nhorman@tuxdriver.com>
> Cc: dev@dpdk.org, Thomas Monjalon <thomas@monjalon.net>, Ferruh Yigit
>  <ferruh.yigit@intel.com>, Gaetan Rivet <gaetan.rivet@6wind.com>
> Subject: [dpdk-dev] [PATCH] doc: announce deprecation of flow copy function
> X-Mailer: git-send-email 2.11.0
> 
> 
> Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>
> Cc: Ferruh Yigit <ferruh.yigit@intel.com>
> Cc: Gaetan Rivet <gaetan.rivet@6wind.com>


Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>

> ---
>  doc/guides/rel_notes/deprecation.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 14714fe94..05c77da65 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -68,3 +68,10 @@ Deprecation Notices
>    - ``rte_pdump_set_socket_dir`` will be removed;
>    - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
>    - The enum ``rte_pdump_socktype`` will be removed.
> +
> +* ethdev: flow API function ``rte_flow_copy()`` will be deprecated in v18.11
> +  in favor of ``rte_flow_conv()`` (which will appear in that version) and
> +  subsequently removed for v19.02.
> +
> +  This is due to a lack of flexibility and reliance on a type unusable with
> +  C++ programs (struct rte_flow_desc).
> --
> 2.11.0
Thomas Monjalon Aug. 8, 2018, 10:38 p.m. | #4
08/08/2018 05:11, Jerin Jacob:
> -----Original Message-----
> > Date: Fri, 3 Aug 2018 16:37:52 +0200
> > From: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> > To: Neil Horman <nhorman@tuxdriver.com>
> > Cc: dev@dpdk.org, Thomas Monjalon <thomas@monjalon.net>, Ferruh Yigit
> >  <ferruh.yigit@intel.com>, Gaetan Rivet <gaetan.rivet@6wind.com>
> > Subject: [dpdk-dev] [PATCH] doc: announce deprecation of flow copy function
> > X-Mailer: git-send-email 2.11.0
> > 
> > 
> > Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>

    Acked-by: Thomas Monjalon <thomas@monjalon.net>
    Acked-by: Maxime Coquelin <maxime.coquelin@redhat.com>
    Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>

Applied, thanks

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 14714fe94..05c77da65 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -68,3 +68,10 @@  Deprecation Notices
   - ``rte_pdump_set_socket_dir`` will be removed;
   - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
   - The enum ``rte_pdump_socktype`` will be removed.
+
+* ethdev: flow API function ``rte_flow_copy()`` will be deprecated in v18.11
+  in favor of ``rte_flow_conv()`` (which will appear in that version) and
+  subsequently removed for v19.02.
+
+  This is due to a lack of flexibility and reliance on a type unusable with
+  C++ programs (struct rte_flow_desc).