From e76d76b27be270b0eaba52b3a6bbc7860a9197af Mon Sep 17 00:00:00 2001 From: Dekel Peled Date: Wed, 9 Jan 2019 13:37:59 +0200 Subject: [PATCH] doc: fix MAC address rewrite actions in prog guide 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 Signed-off-by: Dekel Peled Acked-by: Ori Kam --- 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 c186375009..dbf4999aa7 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: -- 2.20.1