doc: fix description of some mlx5 features

Message ID 20210519142056.2140211-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: fix description of some mlx5 features |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Thomas Monjalon May 19, 2021, 2:20 p.m. UTC
  From: Asaf Penso <asafp@nvidia.com>

The support of the new RTE_FLOW_ITEM_TYPE_INTEGRITY
was added in the release notes 21.02 by mistake.

The support of the Sub-Function representors was missing
in the release notes and the mlx5 guide.

Fixes: 79f8952783d0 ("net/mlx5: support integrity flow item")
Fixes: cb95feefdd03 ("net/mlx5: support sub-function representor")

Signed-off-by: Asaf Penso <asafp@nvidia.com>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/nics/mlx5.rst               | 8 +++++---
 doc/guides/rel_notes/release_21_02.rst | 1 -
 doc/guides/rel_notes/release_21_05.rst | 2 ++
 3 files changed, 7 insertions(+), 4 deletions(-)
  

Comments

Thomas Monjalon May 19, 2021, 3:12 p.m. UTC | #1
19/05/2021 16:20, Thomas Monjalon:
> From: Asaf Penso <asafp@nvidia.com>
> 
> The support of the new RTE_FLOW_ITEM_TYPE_INTEGRITY
> was added in the release notes 21.02 by mistake.
> 
> The support of the Sub-Function representors was missing
> in the release notes and the mlx5 guide.
> 
> Fixes: 79f8952783d0 ("net/mlx5: support integrity flow item")
> Fixes: cb95feefdd03 ("net/mlx5: support sub-function representor")
> 
> Signed-off-by: Asaf Penso <asafp@nvidia.com>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Applied
  

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7d41cacaaa..220c6e505a 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -109,6 +109,7 @@  Features
 - Flow metering, including meter policy API.
 - Flow integrity offload API.
 - Connection tracking.
+- Sub-Function representors.
 
 Limitations
 -----------
@@ -1437,9 +1438,10 @@  the DPDK application.
 
         echo switchdev > /sys/class/net/<net device>/compat/devlink/mode
 
-SubFunction representor support
--------------------------------
-SubFunction is a portion of the PCI device, a SF netdev has its own
+Sub-Function representor
+------------------------
+
+Sub-Function is a portion of the PCI device, a SF netdev has its own
 dedicated queues(txq, rxq). A SF netdev supports E-Switch representation
 offload similar to existing PF and VF representors. A SF shares PCI
 level resources with other SFs and/or with its parent PCI function.
diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
index ce27879f08..1813fe767a 100644
--- a/doc/guides/rel_notes/release_21_02.rst
+++ b/doc/guides/rel_notes/release_21_02.rst
@@ -138,7 +138,6 @@  New Features
     egress flow groups greater than 0 and for any transfer flow group.
   * Added support for the Tx mbuf fast free offload.
   * Added support for flow modify field action.
-  * Added support for flow integrity item.
 
 * **Updated the Pensando ionic driver.**
 
diff --git a/doc/guides/rel_notes/release_21_05.rst b/doc/guides/rel_notes/release_21_05.rst
index 82e8489556..3bae8a499d 100644
--- a/doc/guides/rel_notes/release_21_05.rst
+++ b/doc/guides/rel_notes/release_21_05.rst
@@ -171,6 +171,7 @@  New Features
 
   Updated the Mellanox mlx5 driver with new features and improvements, including:
 
+  * Added support for matching on packet integrity status.
   * Added support for VXLAN and NVGRE encap as sample actions.
   * Added support for flow COUNT action handle.
   * Support push VLAN on ingress traffic and pop VLAN on egress traffic in E-Switch mode.
@@ -179,6 +180,7 @@  New Features
   * Added support for ASO metering by PPS (packet per second).
   * Added support for the monitor policy of Power Management API.
   * Added support for connection tracking.
+  * Added support for Sub-Function representors.
 
 * **Updated NXP DPAA driver.**