On 19-01-03 22:20:58, Ori Kam wrote:
> PSB
>
> > -----Original Message-----
> > From: dev <[email protected]> On Behalf Of Dekel Peled
> > Sent: Thursday, January 3, 2019 3:09 PM
> > To: Adrien Mazarguil <[email protected]>
> > Cc: [email protected]; Ori Kam <[email protected]>; Dekel Peled
> > <[email protected]>; Jack Min <[email protected]>
> > 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: [email protected]
> >
> > Signed-off-by: Dekel Peled <[email protected]>
> > ---
> > 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
