diff mbox series

doc: update sample actions support in mlx5 guide

Message ID 1615295394-9082-1-git-send-email-jiaweiw@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Raslan Darawsheh
Headers show
Series doc: update sample actions support in mlx5 guide | expand

Checks

Context Check Description
ci/github-robot success github build: passed
ci/travis-robot success travis build: passed
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Jiawei Wang March 9, 2021, 1:09 p.m. UTC
Updates the documentation for supported sample actions in the NIC Rx
and E-Switch steering flow.

Signed-off-by: Jiawei Wang <jiaweiw@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
 doc/guides/nics/mlx5.rst | 2 ++
 1 file changed, 2 insertions(+)

Comments

Thomas Monjalon March 9, 2021, 1:39 p.m. UTC | #1
09/03/2021 14:09, Jiawei Wang:
> +  - Supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` as sample actions for NIC Rx sampling/mirroring flow.

"sample actions for NIC Rx sampling" is redundant.
I suggest "Supports [...] actions for NIC Rx flow sampling/mirroring."

> +  - Supports ``RAW ENCAP``, ``Port ID`` as sample actions for E-Switch mirroring (sample ratio = 1) flow.

I suggest "Supports [...] actions for E-Switch flow mirroring."

If lines are long, do not hesitate to start a new line after a punctuation.
Jiawei Wang March 12, 2021, 9:44 a.m. UTC | #2
Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Tuesday, March 9, 2021 9:39 PM
> To: Jiawei(Jonny) Wang <jiaweiw@nvidia.com>
> Cc: Slava Ovsiienko <viacheslavo@nvidia.com>; Matan Azrad
> <matan@nvidia.com>; Ori Kam <orika@nvidia.com>; dev@dpdk.org; Raslan
> Darawsheh <rasland@nvidia.com>
> Subject: Re: [PATCH] doc: update sample actions support in mlx5 guide
> 
> 09/03/2021 14:09, Jiawei Wang:
> > +  - Supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` as sample actions for
> NIC Rx sampling/mirroring flow.
> 
> "sample actions for NIC Rx sampling" is redundant.
> I suggest "Supports [...] actions for NIC Rx flow sampling/mirroring."
> 

These actions are support in the sample action list, user also can add modify, decap , encap in the NIC RX flow;
How about this:

"For NIC RX flow with sample action, Supports [...] actions in the sample action list" ? 

> > +  - Supports ``RAW ENCAP``, ``Port ID`` as sample actions for E-Switch
> mirroring (sample ratio = 1) flow.
> 
> I suggest "Supports [...] actions for E-Switch flow mirroring."
> 
> If lines are long, do not hesitate to start a new line after a punctuation.
> 

Ok, I will split into two lines.

Thanks.
Thomas Monjalon March 12, 2021, 3:51 p.m. UTC | #3
12/03/2021 10:44, Jiawei(Jonny) Wang:
> From: Thomas Monjalon <thomas@monjalon.net>
> > 09/03/2021 14:09, Jiawei Wang:
> > > +  - Supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` as sample actions for
> > NIC Rx sampling/mirroring flow.
> > 
> > "sample actions for NIC Rx sampling" is redundant.
> > I suggest "Supports [...] actions for NIC Rx flow sampling/mirroring."
> > 
> 
> These actions are support in the sample action list, user also can add modify, decap , encap in the NIC RX flow;
> How about this:
> 
> "For NIC RX flow with sample action, Supports [...] actions in the sample action list" ?

Another suggestion:
For NIC Rx flow, supports [...] in the sampling actions list.


> > > +  - Supports ``RAW ENCAP``, ``Port ID`` as sample actions for E-Switch
> > mirroring (sample ratio = 1) flow.
> > 
> > I suggest "Supports [...] actions for E-Switch flow mirroring."
> > 
> > If lines are long, do not hesitate to start a new line after a punctuation.
> > 
> 
> Ok, I will split into two lines.
> 
> Thanks.
diff mbox series

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 7c50497..2aa7483 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -370,6 +370,8 @@  Limitations
   - Supports ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action only within NIC Rx and E-Switch steering domain.
   - The E-Switch Sample flow must have the eswitch_manager VPORT destination (PF or ECPF) and no additional actions.
   - For ConnectX-5, the ``RTE_FLOW_ACTION_TYPE_SAMPLE`` is typically used as first action in the E-Switch egress flow if with header modify or encapsulation actions.
+  - Supports ``MARK``, ``COUNT``, ``QUEUE``, ``RSS`` as sample actions for NIC Rx sampling/mirroring flow.
+  - Supports ``RAW ENCAP``, ``Port ID`` as sample actions for E-Switch mirroring (sample ratio = 1) flow.
 
 - Modify Field flow: