doc: fix MAC address rewrite actions documentation
diff mbox series

Message ID 1546520931-60894-1-git-send-email-dekelp@mellanox.com
State Changes Requested, archived
Delegated to: Ferruh Yigit
Headers show
Series
  • doc: fix MAC address rewrite actions documentation
Related show

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS
ci/Intel-compilation success Compilation OK

Commit Message

Dekel Peled Jan. 3, 2019, 1:08 p.m. UTC
This patch fixes a typo in SET_MAC_DST action description.
It also adds restriction note for set MAC src/dst actions description.

Fixes: 15dbcdaada77 ("ethdev: add generic MAC address rewrite actions")
Cc: jackmin@mellanox.com

Signed-off-by: Dekel Peled <dekelp@mellanox.com>
---
 doc/guides/prog_guide/rte_flow.rst | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

Comments

Ori Kam Jan. 3, 2019, 2:20 p.m. UTC | #1
PSB

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
> Sent: Thursday, January 3, 2019 3:09 PM
> To: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> Cc: dev@dpdk.org; Ori Kam <orika@mellanox.com>; Dekel Peled
> <dekelp@mellanox.com>; Jack Min <jackmin@mellanox.com>
> Subject: [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions
> documentation
> 
> This patch fixes a typo in SET_MAC_DST action description.
> It also adds restriction note for set MAC src/dst actions description.
> 
> Fixes: 15dbcdaada77 ("ethdev: add generic MAC address rewrite actions")
> Cc: jackmin@mellanox.com
> 
> Signed-off-by: Dekel Peled <dekelp@mellanox.com>
> ---
>  doc/guides/prog_guide/rte_flow.rst | 10 ++++++++--
>  1 file changed, 8 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/prog_guide/rte_flow.rst
> b/doc/guides/prog_guide/rte_flow.rst
> index c186375..df1ac2f 100644
> --- a/doc/guides/prog_guide/rte_flow.rst
> +++ b/doc/guides/prog_guide/rte_flow.rst
> @@ -2314,7 +2314,10 @@ in pattern, Some PMDs will reject rule because
> behaviour will be undefined.
>  Action: ``SET_MAC_SRC``
>  ^^^^^^^^^^^^^^^^^^^^^^^
> 
> -Set source MAC address
> +Set source MAC address in the outermost Ethernet header.

This line is incorrect in case we have encap action the modified MAC will be the inner.

> +
> +It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
> +Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
> 
>  .. _table_rte_flow_action_set_mac_src:
> 
> @@ -2329,7 +2332,10 @@ Set source MAC address
>  Action: ``SET_MAC_DST``
>  ^^^^^^^^^^^^^^^^^^^^^^^
> 
> -Set source MAC address
> +Set destination MAC address in the outermost Ethernet header.

This line is incorrect in case we have encap action the modified MAC will be the inner.

> +
> +It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
> +Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
> 
>  .. _table_rte_flow_action_set_mac_dst:
> 
> --
> 1.8.3.1


Thanks,
Ori
Jack Min Jan. 8, 2019, 8:34 a.m. UTC | #2
On 19-01-03 22:20:58, Ori Kam wrote:
> PSB
> 
> > -----Original Message-----
> > From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
> > Sent: Thursday, January 3, 2019 3:09 PM
> > To: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> > Cc: dev@dpdk.org; Ori Kam <orika@mellanox.com>; Dekel Peled
> > <dekelp@mellanox.com>; Jack Min <jackmin@mellanox.com>
> > Subject: [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions
> > documentation
> > 
> > This patch fixes a typo in SET_MAC_DST action description.
> > It also adds restriction note for set MAC src/dst actions description.
> > 
> > Fixes: 15dbcdaada77 ("ethdev: add generic MAC address rewrite actions")
> > Cc: jackmin@mellanox.com
> > 
> > Signed-off-by: Dekel Peled <dekelp@mellanox.com>
> > ---
> >  doc/guides/prog_guide/rte_flow.rst | 10 ++++++++--
> >  1 file changed, 8 insertions(+), 2 deletions(-)
> > 
> > diff --git a/doc/guides/prog_guide/rte_flow.rst
> > b/doc/guides/prog_guide/rte_flow.rst
> > index c186375..df1ac2f 100644
> > --- a/doc/guides/prog_guide/rte_flow.rst
> > +++ b/doc/guides/prog_guide/rte_flow.rst
> > @@ -2314,7 +2314,10 @@ in pattern, Some PMDs will reject rule because
> > behaviour will be undefined.
> >  Action: ``SET_MAC_SRC``
> >  ^^^^^^^^^^^^^^^^^^^^^^^
> > 
> > -Set source MAC address
> > +Set source MAC address in the outermost Ethernet header.
> 
> This line is incorrect in case we have encap action the modified MAC will be the inner.
> 
Ori, I think it more likes PMD-specific behaviour and not for API in general.
What do you think ? 
> > +
> > +It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
> > +Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
> > 
> >  .. _table_rte_flow_action_set_mac_src:
> > 
> > @@ -2329,7 +2332,10 @@ Set source MAC address
> >  Action: ``SET_MAC_DST``
> >  ^^^^^^^^^^^^^^^^^^^^^^^
> > 
> > -Set source MAC address
> > +Set destination MAC address in the outermost Ethernet header.
> 
> This line is incorrect in case we have encap action the modified MAC will be the inner.
> 
> > +
> > +It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
> > +Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
> > 
> >  .. _table_rte_flow_action_set_mac_dst:
> > 
> > --
> > 1.8.3.1
> 
> 
> Thanks,
> Ori
Ori Kam Jan. 9, 2019, 7:37 a.m. UTC | #3
> -----Original Message-----
> From: Jack Min
> Sent: Tuesday, January 8, 2019 10:34 AM
> To: Ori Kam <orika@mellanox.com>
> Cc: Dekel Peled <dekelp@mellanox.com>; Adrien Mazarguil
> <adrien.mazarguil@6wind.com>; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions
> documentation
> 
> On 19-01-03 22:20:58, Ori Kam wrote:
> > PSB
> >
> > > -----Original Message-----
> > > From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
> > > Sent: Thursday, January 3, 2019 3:09 PM
> > > To: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> > > Cc: dev@dpdk.org; Ori Kam <orika@mellanox.com>; Dekel Peled
> > > <dekelp@mellanox.com>; Jack Min <jackmin@mellanox.com>
> > > Subject: [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions
> > > documentation
> > >
> > > This patch fixes a typo in SET_MAC_DST action description.
> > > It also adds restriction note for set MAC src/dst actions description.
> > >
> > > Fixes: 15dbcdaada77 ("ethdev: add generic MAC address rewrite actions")
> > > Cc: jackmin@mellanox.com
> > >
> > > Signed-off-by: Dekel Peled <dekelp@mellanox.com>
> > > ---
> > >  doc/guides/prog_guide/rte_flow.rst | 10 ++++++++--
> > >  1 file changed, 8 insertions(+), 2 deletions(-)
> > >
> > > diff --git a/doc/guides/prog_guide/rte_flow.rst
> > > b/doc/guides/prog_guide/rte_flow.rst
> > > index c186375..df1ac2f 100644
> > > --- a/doc/guides/prog_guide/rte_flow.rst
> > > +++ b/doc/guides/prog_guide/rte_flow.rst
> > > @@ -2314,7 +2314,10 @@ in pattern, Some PMDs will reject rule because
> > > behaviour will be undefined.
> > >  Action: ``SET_MAC_SRC``
> > >  ^^^^^^^^^^^^^^^^^^^^^^^
> > >
> > > -Set source MAC address
> > > +Set source MAC address in the outermost Ethernet header.
> >
> > This line is incorrect in case we have encap action the modified MAC will be
> the inner.
> >
> Ori, I think it more likes PMD-specific behaviour and not for API in general.
> What do you think ?

Yes this is why the comment is incorrect. We can't say that in all PMD and in all
cases we modified the outer most.
The header which is changed it based on the action order.

> > > +
> > > +It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern
> item.
> > > +Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
> > >
> > >  .. _table_rte_flow_action_set_mac_src:
> > >
> > > @@ -2329,7 +2332,10 @@ Set source MAC address
> > >  Action: ``SET_MAC_DST``
> > >  ^^^^^^^^^^^^^^^^^^^^^^^
> > >
> > > -Set source MAC address
> > > +Set destination MAC address in the outermost Ethernet header.
> >
> > This line is incorrect in case we have encap action the modified MAC will be
> the inner.
> >
> > > +
> > > +It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern
> item.
> > > +Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
> > >
> > >  .. _table_rte_flow_action_set_mac_dst:
> > >
> > > --
> > > 1.8.3.1
> >
> >
> > Thanks,
> > Ori

Patch
diff mbox series

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index c186375..df1ac2f 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -2314,7 +2314,10 @@  in pattern, Some PMDs will reject rule because behaviour will be undefined.
 Action: ``SET_MAC_SRC``
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-Set source MAC address
+Set source MAC address in the outermost Ethernet header.
+
+It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
+Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
 
 .. _table_rte_flow_action_set_mac_src:
 
@@ -2329,7 +2332,10 @@  Set source MAC address
 Action: ``SET_MAC_DST``
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-Set source MAC address
+Set destination MAC address in the outermost Ethernet header.
+
+It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
+Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
 
 .. _table_rte_flow_action_set_mac_dst: