doc: announce deprecation of port mirroring API
diff mbox series

Message ID 20200803153309.3274969-1-thomas@monjalon.net
State Accepted, archived
Headers show
Series
  • doc: announce deprecation of port mirroring API
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Thomas Monjalon Aug. 3, 2020, 3:33 p.m. UTC
A new API is planned to be introduced for sampling and mirroring
with rte_flow. It should be more generic and allow more use cases.

This deprecation is to show the direction, avoiding overlapping APIs.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Jerin Jacob Aug. 3, 2020, 3:35 p.m. UTC | #1
On Mon, Aug 3, 2020 at 9:03 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> A new API is planned to be introduced for sampling and mirroring
> with rte_flow. It should be more generic and allow more use cases.
>
> This deprecation is to show the direction, avoiding overlapping APIs.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: Jerin Jacob <jerinj@marvell.com>


> ---
>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 6e12e57a13..ca0d8af96a 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -103,6 +103,12 @@ Deprecation Notices
>    Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
>    APIs can be used as replacement.
>
> +* ethdev: The port mirroring API can be replaced with a more fine grain flow API.
> +  The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions
> +  ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked
> +  as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
> +  This API will be fully removed in DPDK 21.11.
> +
>  * ethdev: Some internal APIs for driver usage are exported in the .map file.
>    Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move
>    them to the INTERNAL block in .map. Although these APIs are internal it will
> --
> 2.27.0
>
Andrew Rybchenko Aug. 3, 2020, 3:36 p.m. UTC | #2
On 8/3/20 6:33 PM, Thomas Monjalon wrote:
> A new API is planned to be introduced for sampling and mirroring
> with rte_flow. It should be more generic and allow more use cases.
>
> This deprecation is to show the direction, avoiding overlapping APIs.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

I like the idea. Not everything is 100% clear, but the direction is right.

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Ajit Khaparde Aug. 3, 2020, 5:59 p.m. UTC | #3
On Mon, Aug 3, 2020 at 8:36 AM Andrew Rybchenko <arybchenko@solarflare.com>
wrote:

> On 8/3/20 6:33 PM, Thomas Monjalon wrote:
> > A new API is planned to be introduced for sampling and mirroring
> > with rte_flow. It should be more generic and allow more use cases.
> >
> > This deprecation is to show the direction, avoiding overlapping APIs.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>
> I like the idea. Not everything is 100% clear, but the direction is right.
>
+1


>
> Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
David Marchand Aug. 4, 2020, 7:25 a.m. UTC | #4
On Mon, Aug 3, 2020 at 5:33 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> A new API is planned to be introduced for sampling and mirroring
> with rte_flow. It should be more generic and allow more use cases.
>
> This deprecation is to show the direction, avoiding overlapping APIs.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: David Marchand <david.marchand@redhat.com>
Thomas Monjalon Aug. 6, 2020, 12:44 a.m. UTC | #5
> > > A new API is planned to be introduced for sampling and mirroring
> > > with rte_flow. It should be more generic and allow more use cases.
> > >
> > > This deprecation is to show the direction, avoiding overlapping APIs.
> > >
> > > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> Acked-by: Jerin Jacob <jerinj@marvell.com>
> > 
> > I like the idea. Not everything is 100% clear, but the direction is right.
> >
> +1
> 
> > Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> Acked-by: David Marchand <david.marchand@redhat.com>

Applied

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 6e12e57a13..ca0d8af96a 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -103,6 +103,12 @@  Deprecation Notices
   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
   APIs can be used as replacement.
 
+* ethdev: The port mirroring API can be replaced with a more fine grain flow API.
+  The structs ``rte_eth_mirror_conf``, ``rte_eth_vlan_mirror`` and the functions
+  ``rte_eth_mirror_rule_set``, ``rte_eth_mirror_rule_reset`` will be marked
+  as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
+  This API will be fully removed in DPDK 21.11.
+
 * ethdev: Some internal APIs for driver usage are exported in the .map file.
   Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move
   them to the INTERNAL block in .map. Although these APIs are internal it will