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

[Ori Kam]

> -----Original Message-----
> From: dev <dev-bounces at dpdk.org> On Behalf Of Dekel Peled
> Sent: Tuesday, October 23, 2018 4:29 PM
> To: wenzhuo.lu at intel.com; jingjing.wu at intel.com;
> bernard.iremonger at intel.com; olivier.matz at 6wind.com; Adrien Mazarguil
> <adrien.mazarguil at 6wind.com>; Thomas Monjalon <thomas at monjalon.net>;
> ferruh.yigit at intel.com; arybchenko at solarflare.com
> Cc: Shahaf Shuler <shahafs at mellanox.com>; dev at dpdk.org; Ori Kam
> <orika at mellanox.com>; Dekel Peled <dekelp at mellanox.com>
> Subject: [dpdk-dev] [PATCH 2/2] ethdev: fix metadata documentation
> 
> 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.
> 
Are you sure from the impelmetion it looks like default mask is all ones,
This means that the first comment is the correct one.

>  .. _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