[v2] doc: fix MAC address rewrite actions documentation
Checks
Commit Message
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
> -----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
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:
>
>
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.
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.
@@ -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: