* [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions documentation
@ 2019-01-03 13:08 Dekel Peled
2019-01-03 14:20 ` Ori Kam
2019-01-09 11:37 ` [dpdk-dev] [PATCH v2] " Dekel Peled
0 siblings, 2 replies; 9+ messages in thread
From: Dekel Peled @ 2019-01-03 13:08 UTC (permalink / raw)
To: adrien.mazarguil; +Cc: dev, orika, dekelp, jackmin
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.
+
+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:
--
1.8.3.1
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions documentation
2019-01-03 13:08 [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions documentation Dekel Peled
@ 2019-01-03 14:20 ` Ori Kam
2019-01-08 8:34 ` Jack Min
2019-01-09 11:37 ` [dpdk-dev] [PATCH v2] " Dekel Peled
1 sibling, 1 reply; 9+ messages in thread
From: Ori Kam @ 2019-01-03 14:20 UTC (permalink / raw)
To: Dekel Peled, Adrien Mazarguil; +Cc: dev, Dekel Peled, Jack Min
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
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions documentation
2019-01-03 14:20 ` Ori Kam
@ 2019-01-08 8:34 ` Jack Min
2019-01-09 7:37 ` Ori Kam
0 siblings, 1 reply; 9+ messages in thread
From: Jack Min @ 2019-01-08 8:34 UTC (permalink / raw)
To: Ori Kam; +Cc: Dekel Peled, Adrien Mazarguil, dev
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
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions documentation
2019-01-08 8:34 ` Jack Min
@ 2019-01-09 7:37 ` Ori Kam
0 siblings, 0 replies; 9+ messages in thread
From: Ori Kam @ 2019-01-09 7:37 UTC (permalink / raw)
To: Jack Min; +Cc: Dekel Peled, Adrien Mazarguil, dev
> -----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
^ permalink raw reply [flat|nested] 9+ messages in thread
* [dpdk-dev] [PATCH v2] doc: fix MAC address rewrite actions documentation
2019-01-03 13:08 [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions documentation Dekel Peled
2019-01-03 14:20 ` Ori Kam
@ 2019-01-09 11:37 ` Dekel Peled
2019-01-09 21:12 ` Ori Kam
2019-01-10 18:16 ` Kevin Traynor
1 sibling, 2 replies; 9+ messages in thread
From: Dekel Peled @ 2019-01-09 11:37 UTC (permalink / raw)
To: adrien.mazarguil; +Cc: dev, orika, dekelp, jackmin
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..dbf4999 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.
+
+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.
+
+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
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [PATCH v2] doc: fix MAC address rewrite actions documentation
2019-01-09 11:37 ` [dpdk-dev] [PATCH v2] " Dekel Peled
@ 2019-01-09 21:12 ` Ori Kam
2019-01-11 16:57 ` Ferruh Yigit
2019-01-10 18:16 ` Kevin Traynor
1 sibling, 1 reply; 9+ messages in thread
From: Ori Kam @ 2019-01-09 21:12 UTC (permalink / raw)
To: Dekel Peled, Adrien Mazarguil; +Cc: dev, Dekel Peled, Jack Min
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
> Sent: Wednesday, January 9, 2019 1:38 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 v2] 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..dbf4999 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.
> +
> +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.
> +
> +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
Acked-by: Ori Kam <orika@mellanox.com>
Thanks,
Ori
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [PATCH v2] doc: fix MAC address rewrite actions documentation
2019-01-09 21:12 ` Ori Kam
@ 2019-01-11 16:57 ` Ferruh Yigit
0 siblings, 0 replies; 9+ messages in thread
From: Ferruh Yigit @ 2019-01-11 16:57 UTC (permalink / raw)
To: Ori Kam, Dekel Peled, Adrien Mazarguil; +Cc: dev, Jack Min
On 1/9/2019 9:12 PM, Ori Kam wrote:
>
>
>> -----Original Message-----
>> From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
>> Sent: Wednesday, January 9, 2019 1:38 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 v2] 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>
>
> Acked-by: Ori Kam <orika@mellanox.com>
Applied to dpdk-next-net/master, thanks.
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [dpdk-dev] [PATCH v2] doc: fix MAC address rewrite actions documentation
2019-01-09 11:37 ` [dpdk-dev] [PATCH v2] " Dekel Peled
2019-01-09 21:12 ` Ori Kam
@ 2019-01-10 18:16 ` Kevin Traynor
2019-01-11 16:57 ` Ferruh Yigit
1 sibling, 1 reply; 9+ messages in thread
From: Kevin Traynor @ 2019-01-10 18:16 UTC (permalink / raw)
To: Dekel Peled, adrien.mazarguil; +Cc: dev, orika, jackmin
On 01/09/2019 11:37 AM, Dekel Peled wrote:
> 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: stable@dpdk.org
unless there's a reason not to
> 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..dbf4999 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.
> +
> +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.
> +
> +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:
>
>
^ permalink raw reply [flat|nested] 9+ messages in thread* Re: [dpdk-dev] [PATCH v2] doc: fix MAC address rewrite actions documentation
2019-01-10 18:16 ` Kevin Traynor
@ 2019-01-11 16:57 ` Ferruh Yigit
0 siblings, 0 replies; 9+ messages in thread
From: Ferruh Yigit @ 2019-01-11 16:57 UTC (permalink / raw)
To: Kevin Traynor, Dekel Peled, adrien.mazarguil; +Cc: dev, orika, jackmin
On 1/10/2019 6:16 PM, Kevin Traynor wrote:
> On 01/09/2019 11:37 AM, Dekel Peled wrote:
>> 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: stable@dpdk.org
>
> unless there's a reason not to
stable tag added while merging.
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2019-01-11 16:57 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-01-03 13:08 [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions documentation Dekel Peled
2019-01-03 14:20 ` Ori Kam
2019-01-08 8:34 ` Jack Min
2019-01-09 7:37 ` Ori Kam
2019-01-09 11:37 ` [dpdk-dev] [PATCH v2] " Dekel Peled
2019-01-09 21:12 ` Ori Kam
2019-01-11 16:57 ` Ferruh Yigit
2019-01-10 18:16 ` Kevin Traynor
2019-01-11 16:57 ` Ferruh Yigit
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).