doc: refine ethernet and VLAN flow rule items
authorDekel Peled <dekelp@mellanox.com>
Sun, 3 May 2020 07:17:22 +0000 (10:17 +0300)
committerFerruh Yigit <ferruh.yigit@intel.com>
Mon, 11 May 2020 20:27:39 +0000 (22:27 +0200)
commit6b3042882060af2e5acbcf144baa58aa0af2cc14
tree949a159a334318e64eb037d5d62d1055be745168
parentf9295aa22051921a15f107b740682711ff43fb47
doc: refine ethernet and VLAN flow rule items

Specified pattern may be translated in different manner.
For example the pattern "eth / ipv4" can be translated to match
untagged packets only, since the pattern doesn't specify a VLAN item.
It can also be translated to match both tagged and untagged packets,
for the same reason.
This patch updates the rte_flow documentation to clearly specify the
required pattern to use.
For example:
To match tagged ipv4 packets, the pattern "eth / vlan / ipv4 / end"
should be used.
To match untagged ipv4 packets, the pattern "eth / ipv4 / end"
should be used.
To match all IPV4 packets, both tagged and untagged, need to apply
two rules with the patterns above.
To match both tagged and untagged packets of any type, the pattern
"eth / end" should be used.

Signed-off-by: Dekel Peled <dekelp@mellanox.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Acked-by: Ori Kam <orika@mellanox.com>
doc/guides/prog_guide/rte_flow.rst
lib/librte_ethdev/rte_flow.h