diff mbox series

doc: fix mark action zero value description in mlx5 guide

Message ID 20210205121504.10994-1-viacheslavo@nvidia.com (mailing list archive)
State Accepted, archived
Delegated to: Raslan Darawsheh
Headers
Series doc: fix mark action zero value description in mlx5 guide |

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/travis-robot warning Travis build: failed
ci/checkpatch success coding style OK

Commit Message

Slava Ovsiienko Feb. 5, 2021, 12:15 p.m. UTC 
  The zero value in flow MARK action is reported in Rx datapath
as tagged with zero FDIR ID. Once packet is marked in flow engine
it will be always reported as tagged. For metadata only the zero
value means there is "no metadata" in the packet and the metadata
flag is not set for the case.

Fixes: 3ceeed9f7855 ("doc: update flow mark action in mlx5 guide")
Cc: stable@dpdk.org

Signed-off-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
 doc/guides/nics/mlx5.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Comments

Raslan Darawsheh Feb. 9, 2021, 8:36 a.m. UTC | #1 
Hi,
> -----Original Message-----
> From: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
> Sent: Friday, February 5, 2021 2:15 PM
> To: dev@dpdk.org
> Cc: Raslan Darawsheh <rasland@nvidia.com>; Matan Azrad
> <matan@nvidia.com>; stable@dpdk.org
> Subject: [PATCH] doc: fix mark action zero value description in mlx5 guide
> 
> The zero value in flow MARK action is reported in Rx datapath
> as tagged with zero FDIR ID. Once packet is marked in flow engine
> it will be always reported as tagged. For metadata only the zero
> value means there is "no metadata" in the packet and the metadata
> flag is not set for the case.
> 
> Fixes: 3ceeed9f7855 ("doc: update flow mark action in mlx5 guide")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
> ---

Patch applied to next-net-mlx,

Kindest regards,
Raslan Darawsheh
diff mbox series

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 51d81a0206..2f3b0356d3 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -875,8 +875,10 @@  Driver options
   of the extensive metadata features. The legacy Verbs supports FLAG and
   MARK metadata actions over NIC Rx steering domain only.
 
-  The setting MARK or META value to zero means there is no item provided and
-  receiving datapath will not report in mbufs these items are present.
+  The setting META value to zero in flow action means there is no item provided
+  and receiving datapath will not report in mbufs the metadata are present.
+  The setting MARK value to zero in flow action means the zero FDIR ID value
+  will be reported on packet receiving.
 
   For the MARK action the last 16 values in the full range are reserved for
   internal PMD purposes (to emulate FLAG action). The valid range for the