From: Dekel Peled <dekelp@mellanox.com>
To: adrien.mazarguil@6wind.com
Cc: dev@dpdk.org, orika@mellanox.com, dekelp@mellanox.com,
jackmin@mellanox.com
Subject: [dpdk-dev] [PATCH] doc: fix MAC address rewrite actions documentation
Date: Thu, 3 Jan 2019 15:08:51 +0200 [thread overview]
Message-ID: <1546520931-60894-1-git-send-email-dekelp@mellanox.com> (raw)
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..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:
--
1.8.3.1
next reply other threads:[~2019-01-03 13:15 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-03 13:08 Dekel Peled [this message]
2019-01-03 14:20 ` Ori Kam
2019-01-08 8:34 ` Jack Min
2019-01-09 7:37 ` Ori Kam
2019-01-09 11:37 ` [dpdk-dev] [PATCH v2] " Dekel Peled
2019-01-09 21:12 ` Ori Kam
2019-01-11 16:57 ` Ferruh Yigit
2019-01-10 18:16 ` Kevin Traynor
2019-01-11 16:57 ` Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1546520931-60894-1-git-send-email-dekelp@mellanox.com \
--to=dekelp@mellanox.com \
--cc=adrien.mazarguil@6wind.com \
--cc=dev@dpdk.org \
--cc=jackmin@mellanox.com \
--cc=orika@mellanox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).