[v2,2/2] ethdev: fix metadata documentation
Checks
Commit Message
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@mellanox.com
---
v2:
Restore the correct 'mask' description.
---
Signed-off-by: Dekel Peled <dekelp@mellanox.com>
---
doc/guides/prog_guide/rte_flow.rst | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
Comments
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
> Sent: Wednesday, October 24, 2018 9:22 AM
> To: wenzhuo.lu@intel.com; jingjing.wu@intel.com;
> bernard.iremonger@intel.com; olivier.matz@6wind.com; Adrien Mazarguil
> <adrien.mazarguil@6wind.com>; Thomas Monjalon <thomas@monjalon.net>;
> ferruh.yigit@intel.com; arybchenko@solarflare.com
> Cc: Shahaf Shuler <shahafs@mellanox.com>; dev@dpdk.org; Ori Kam
> <orika@mellanox.com>; Dekel Peled <dekelp@mellanox.com>
> Subject: [dpdk-dev] [PATCH v2 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@mellanox.com
>
> ---
> v2:
> Restore the correct 'mask' description.
> ---
>
> Signed-off-by: Dekel Peled <dekelp@mellanox.com>
> ---
> doc/guides/prog_guide/rte_flow.rst | 18 +++++++++---------
> 1 file changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/doc/guides/prog_guide/rte_flow.rst
> b/doc/guides/prog_guide/rte_flow.rst
> index 6fb0535..5c5dd90 100644
> --- a/doc/guides/prog_guide/rte_flow.rst
> +++ b/doc/guides/prog_guide/rte_flow.rst
> @@ -1202,15 +1202,15 @@ Matches an application specific 32 bit metadata
> item.
>
> .. 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
Acked-by: Ori Kam <orika@mellanox.com>
Thanks,
Ori
@@ -1202,15 +1202,15 @@ Matches an application specific 32 bit metadata item.
.. 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
~~~~~~~