[dpdk-dev] [PATCH 2/2] ethdev: fix metadata documentation

Dekel Peled dekelp at mellanox.com
Tue Oct 23 15:28:51 CEST 2018


Previous patch introduced the Tx metadata feature, with unnecessary
restrictions on data entry.

This fix updates the documentation, removing the data entry
restrictions on metadata item.

Fixes: aa0b9484eb5f ("ethdev: support metadata as flow rule criteria")
Cc: dekelp at mellanox.com

Signed-off-by: Dekel Peled <dekelp at mellanox.com>
---
 doc/guides/prog_guide/rte_flow.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index 6fb0535..d6683e4 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -1196,21 +1196,21 @@ Item: ``META``
 
 Matches an application specific 32 bit metadata item.
 
-- Default ``mask`` matches the specified metadata value.
+- Default ``mask`` matches any 32 bit value.
 
 .. _table_rte_flow_item_meta:
 
 .. table:: META
 
-   +----------+----------+-----------------------+
-   | Field    | Subfield | Value                 |
-   +==========+==========+=======================+
-   | ``spec`` | ``data`` | 32 bit metadata value |
-   +----------+----------------------------------+
-   | ``last`` | ``data`` | ignored               |
-   +----------+----------+-----------------------+
-   | ``mask`` | ``data`` | ignored               |
-   +----------+----------+-----------------------+
+   +----------+----------+---------------------------------------+
+   | Field    | Subfield | Value                                 |
+   +==========+==========+=======================================+
+   | ``spec`` | ``data`` | 32 bit metadata value                 |
+   +----------+--------------------------------------------------+
+   | ``last`` | ``data`` | upper range value                     |
+   +----------+----------+---------------------------------------+
+   | ``mask`` | ``data`` | bit-mask applies to "spec" and "last" |
+   +----------+----------+---------------------------------------+
 
 Actions
 ~~~~~~~
-- 
1.8.3.1



More information about the dev mailing list