[v2,9/9] doc: update cross-port indirect shared action

Message ID 20230207140206.29139-9-viacheslavo@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series [v2,1/9] ethdev: sharing indirect actions between ports |

Checks

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

Commit Message

Slava Ovsiienko Feb. 7, 2023, 2:02 p.m. UTC
  The patch updates the Release Notes and documentation
for the indirect RTE Flow actions as shared ones between
ports on the same physical NIC.

Signed-off-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
 doc/guides/rel_notes/release_23_03.rst      | 6 ++++++
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 +++-
 2 files changed, 9 insertions(+), 1 deletion(-)
  

Comments

Ori Kam Feb. 9, 2023, 2:49 p.m. UTC | #1
Hi Slava,

> -----Original Message-----
> From: Slava Ovsiienko <viacheslavo@nvidia.com>
> Sent: Tuesday, 7 February 2023 16:02
> 
> The patch updates the Release Notes and documentation
> for the indirect RTE Flow actions as shared ones between
> ports on the same physical NIC.
> 
> Signed-off-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
> ---


Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori
  
Ferruh Yigit Feb. 10, 2023, 2:35 p.m. UTC | #2
On 2/7/2023 2:02 PM, Viacheslav Ovsiienko wrote:
> The patch updates the Release Notes and documentation
> for the indirect RTE Flow actions as shared ones between
> ports on the same physical NIC.
> 
> Signed-off-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
> ---
>  doc/guides/rel_notes/release_23_03.rst      | 6 ++++++
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 +++-
>  2 files changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/rel_notes/release_23_03.rst b/doc/guides/rel_notes/release_23_03.rst
> index c15f6fbb9f..eb6643bc66 100644
> --- a/doc/guides/rel_notes/release_23_03.rst
> +++ b/doc/guides/rel_notes/release_23_03.rst
> @@ -55,6 +55,12 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =======================================================
>  
> +* **Added cross-port indirect action in asynchronous Flow API.**
> +
> +  * Added ``RTE_FLOW_PORT_FLAG_SHARE_INDIRECT`` flag option to
> +    ``rte_flow_configure``.
> +  * Added ``host_port_id`` to ``rte_flow_port_attr`` structure.
> +
>  * **Updated Intel QuickAssist Technology (QAT) crypto driver.**
>  
>    * Added support for SHA3 224/256/384/512 plain hash in QAT GEN 3.
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index 0037506a79..cf6c214197 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -3047,7 +3047,9 @@ for asynchronous flow creation/destruction operations. It is bound to
>         [queues_number {number}] [queues_size {size}]
>         [counters_number {number}]
>         [aging_counters_number {number}]
> -       [meters_number {number}] [flags {number}]
> +       [host_port {number}]
> +       [meters_number {number}]
> +       [flags {number}]
>  
>  If successful, it will show::
>  

Can you please distribute the documentation to the patches that actually
adds the documented feature?
So no need to have document only patch.
  

Patch

diff --git a/doc/guides/rel_notes/release_23_03.rst b/doc/guides/rel_notes/release_23_03.rst
index c15f6fbb9f..eb6643bc66 100644
--- a/doc/guides/rel_notes/release_23_03.rst
+++ b/doc/guides/rel_notes/release_23_03.rst
@@ -55,6 +55,12 @@  New Features
      Also, make sure to start the actual text at the margin.
      =======================================================
 
+* **Added cross-port indirect action in asynchronous Flow API.**
+
+  * Added ``RTE_FLOW_PORT_FLAG_SHARE_INDIRECT`` flag option to
+    ``rte_flow_configure``.
+  * Added ``host_port_id`` to ``rte_flow_port_attr`` structure.
+
 * **Updated Intel QuickAssist Technology (QAT) crypto driver.**
 
   * Added support for SHA3 224/256/384/512 plain hash in QAT GEN 3.
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 0037506a79..cf6c214197 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -3047,7 +3047,9 @@  for asynchronous flow creation/destruction operations. It is bound to
        [queues_number {number}] [queues_size {size}]
        [counters_number {number}]
        [aging_counters_number {number}]
-       [meters_number {number}] [flags {number}]
+       [host_port {number}]
+       [meters_number {number}]
+       [flags {number}]
 
 If successful, it will show::