[dpdk-dev] [PATCH v2] doc: fix MAC address rewrite actions documentation

[Kevin Traynor]

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 at dpdk.org

unless there's a reason not to

> Cc: jackmin at mellanox.com
> 
> Signed-off-by: Dekel Peled <dekelp at 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:
>  
>