From patchwork Thu Jan 3 13:08:51 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dekel Peled X-Patchwork-Id: 49399 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 2CE7C5B34; Thu, 3 Jan 2019 14:15:29 +0100 (CET) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by dpdk.org (Postfix) with ESMTP id BDE955A6A for ; Thu, 3 Jan 2019 14:15:27 +0100 (CET) Received: from Internal Mail-Server by MTLPINE1 (envelope-from dekelp@mellanox.com) with ESMTPS (AES256-SHA encrypted); 3 Jan 2019 15:15:22 +0200 Received: from mtl-vdi-280.wap.labs.mlnx. (mtl-vdi-280.wap.labs.mlnx [10.128.130.87]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id x03DFBc9029247; Thu, 3 Jan 2019 15:15:21 +0200 From: Dekel Peled To: adrien.mazarguil@6wind.com Cc: dev@dpdk.org, orika@mellanox.com, dekelp@mellanox.com, jackmin@mellanox.com Date: Thu, 3 Jan 2019 15:08:51 +0200 Message-Id: <1546520931-60894-1-git-send-email-dekelp@mellanox.com> X-Mailer: git-send-email 1.7.1 Subject: [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- 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: