[V1] doc: announce deprecation of flow item VXLAN-GPE

Message ID 20240726085157.197651-1-gavinl@nvidia.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [V1] doc: announce deprecation of flow item VXLAN-GPE |

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/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS
ci/iol-marvell-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS

Commit Message

Gavin Li July 26, 2024, 8:51 a.m. UTC
Adding the deprecation notice as reminder for removing
RTE_FLOW_ITEM_TYPE_VXLAN_GPE and its related structures,
eg. rte_vxlan_gpe_hdr, rte_flow_item_vxlan_gpe, etc.

The proposed time of the removal is DPDK release 25.11.

Signed-off-by: Gavin Li <gavinl@nvidia.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Comments

Ferruh Yigit July 26, 2024, 11:31 a.m. UTC | #1
On 7/26/2024 9:51 AM, Gavin Li wrote:
> Adding the deprecation notice as reminder for removing
> RTE_FLOW_ITEM_TYPE_VXLAN_GPE and its related structures,
> eg. rte_vxlan_gpe_hdr, rte_flow_item_vxlan_gpe, etc.
> 
> The proposed time of the removal is DPDK release 25.11.
> 
> Signed-off-by: Gavin Li <gavinl@nvidia.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 6948641ff6..5c04f88557 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -115,6 +115,13 @@ Deprecation Notices
>    The legacy actions should be removed
>    once ``MODIFY_FIELD`` alternative is implemented in drivers.
>  
> + * ethdev,net: The flow item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE`` is replaced with ``RTE_FLOW_ITEM_TYPE_VXLAN``.
> +   The struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask`` are replaced with
> +   ``rte_flow_item_vxlan and its mask`` and its mask ``rte_flow_item_vxlan_mask``.
> +   The item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE``, the struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask``,
> +   and the header struct ``rte_vxlan_gpe_hdr`` with the macro ``RTE_ETHER_VXLAN_GPE_HLEN``
> +   will be removed in DPDK 25.11.
> +
>  * cryptodev: The function ``rte_cryptodev_cb_fn`` will be updated
>    to have another parameter ``qp_id`` to return the queue pair ID
>    which got error interrupt to the application,
>

Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
  
Thomas Monjalon July 29, 2024, 8:48 a.m. UTC | #2
26/07/2024 13:31, Ferruh Yigit:
> On 7/26/2024 9:51 AM, Gavin Li wrote:
> > Adding the deprecation notice as reminder for removing
> > RTE_FLOW_ITEM_TYPE_VXLAN_GPE and its related structures,
> > eg. rte_vxlan_gpe_hdr, rte_flow_item_vxlan_gpe, etc.
> > 
> > The proposed time of the removal is DPDK release 25.11.
> > 
> > Signed-off-by: Gavin Li <gavinl@nvidia.com>
> > ---
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > + * ethdev,net: The flow item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE`` is replaced with ``RTE_FLOW_ITEM_TYPE_VXLAN``.
> > +   The struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask`` are replaced with
> > +   ``rte_flow_item_vxlan and its mask`` and its mask ``rte_flow_item_vxlan_mask``.
> > +   The item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE``, the struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask``,
> > +   and the header struct ``rte_vxlan_gpe_hdr`` with the macro ``RTE_ETHER_VXLAN_GPE_HLEN``
> > +   will be removed in DPDK 25.11.
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>
  
Ajit Khaparde July 29, 2024, 1:47 p.m. UTC | #3
On Mon, Jul 29, 2024 at 1:48 AM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> 26/07/2024 13:31, Ferruh Yigit:
> > On 7/26/2024 9:51 AM, Gavin Li wrote:
> > > Adding the deprecation notice as reminder for removing
> > > RTE_FLOW_ITEM_TYPE_VXLAN_GPE and its related structures,
> > > eg. rte_vxlan_gpe_hdr, rte_flow_item_vxlan_gpe, etc.
> > >
> > > The proposed time of the removal is DPDK release 25.11.
> > >
> > > Signed-off-by: Gavin Li <gavinl@nvidia.com>
> > > ---
> > > --- a/doc/guides/rel_notes/deprecation.rst
> > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > + * ethdev,net: The flow item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE`` is replaced with ``RTE_FLOW_ITEM_TYPE_VXLAN``.
> > > +   The struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask`` are replaced with
> > > +   ``rte_flow_item_vxlan and its mask`` and its mask ``rte_flow_item_vxlan_mask``.
> > > +   The item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE``, the struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask``,
> > > +   and the header struct ``rte_vxlan_gpe_hdr`` with the macro ``RTE_ETHER_VXLAN_GPE_HLEN``
> > > +   will be removed in DPDK 25.11.
> >
> > Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
>
> Acked-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>

>
>
  
Thomas Monjalon July 31, 2024, 10:33 a.m. UTC | #4
29/07/2024 15:47, Ajit Khaparde:
> On Mon, Jul 29, 2024 at 1:48 AM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > 26/07/2024 13:31, Ferruh Yigit:
> > > On 7/26/2024 9:51 AM, Gavin Li wrote:
> > > > Adding the deprecation notice as reminder for removing
> > > > RTE_FLOW_ITEM_TYPE_VXLAN_GPE and its related structures,
> > > > eg. rte_vxlan_gpe_hdr, rte_flow_item_vxlan_gpe, etc.
> > > >
> > > > The proposed time of the removal is DPDK release 25.11.
> > > >
> > > > Signed-off-by: Gavin Li <gavinl@nvidia.com>
> > > > ---
> > > > --- a/doc/guides/rel_notes/deprecation.rst
> > > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > > + * ethdev,net: The flow item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE`` is replaced with ``RTE_FLOW_ITEM_TYPE_VXLAN``.
> > > > +   The struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask`` are replaced with
> > > > +   ``rte_flow_item_vxlan and its mask`` and its mask ``rte_flow_item_vxlan_mask``.
> > > > +   The item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE``, the struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask``,
> > > > +   and the header struct ``rte_vxlan_gpe_hdr`` with the macro ``RTE_ETHER_VXLAN_GPE_HLEN``
> > > > +   will be removed in DPDK 25.11.
> > >
> > > Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>
> >
> > Acked-by: Thomas Monjalon <thomas@monjalon.net>
> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>

Applied with indent fixed, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 6948641ff6..5c04f88557 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -115,6 +115,13 @@  Deprecation Notices
   The legacy actions should be removed
   once ``MODIFY_FIELD`` alternative is implemented in drivers.
 
+ * ethdev,net: The flow item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE`` is replaced with ``RTE_FLOW_ITEM_TYPE_VXLAN``.
+   The struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask`` are replaced with
+   ``rte_flow_item_vxlan and its mask`` and its mask ``rte_flow_item_vxlan_mask``.
+   The item ``RTE_FLOW_ITEM_TYPE_VXLAN_GPE``, the struct ``rte_flow_item_vxlan_gpe``, its mask ``rte_flow_item_vxlan_gpe_mask``,
+   and the header struct ``rte_vxlan_gpe_hdr`` with the macro ``RTE_ETHER_VXLAN_GPE_HLEN``
+   will be removed in DPDK 25.11.
+
 * cryptodev: The function ``rte_cryptodev_cb_fn`` will be updated
   to have another parameter ``qp_id`` to return the queue pair ID
   which got error interrupt to the application,