[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
Signed-off-by: Dekel Peled <dekelp@mellanox.com>
---
doc/guides/prog_guide/rte_flow.rst | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
Comments
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
> Sent: Tuesday, October 23, 2018 4:29 PM
> 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 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
>
> Signed-off-by: Dekel Peled <dekelp@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
> -----Original Message-----
> From: Ori Kam
> Sent: Tuesday, October 23, 2018 9:06 PM
> To: Dekel Peled <dekelp@mellanox.com>; 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; Dekel Peled
> <dekelp@mellanox.com>
> Subject: RE: [dpdk-dev] [PATCH 2/2] ethdev: fix metadata documentation
>
>
>
> > -----Original Message-----
> > From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
> > Sent: Tuesday, October 23, 2018 4:29 PM
> > 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 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
> >
> > Signed-off-by: Dekel Peled <dekelp@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.
>
Right, will change it.
> > .. _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
@@ -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
~~~~~~~