diff mbox series

[v3,3/3] doc: add single flow dump to guides

Message ID 1618380791-166428-4-git-send-email-haifeil@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers show
Series support single flow dump | expand

Checks

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

Commit Message

Haifei Luo April 14, 2021, 6:13 a.m. UTC
Add "Flow dump" in features/default.ini and features/mlx5.ini.
Add testpmd CLI and API changes in release_notes.

Signed-off-by: Haifei Luo <haifeil@nvidia.com>
---
 doc/guides/nics/features/default.ini   | 1 +
 doc/guides/nics/features/mlx5.ini      | 1 +
 doc/guides/rel_notes/release_21_05.rst | 5 +++++
 3 files changed, 7 insertions(+)

Comments

Ferruh Yigit April 14, 2021, 8:23 a.m. UTC | #1
On 4/14/2021 7:13 AM, Haifei Luo wrote:
> Add "Flow dump" in features/default.ini and features/mlx5.ini.
> Add testpmd CLI and API changes in release_notes.
> 
> Signed-off-by: Haifei Luo <haifeil@nvidia.com>
> ---
>   doc/guides/nics/features/default.ini   | 1 +
>   doc/guides/nics/features/mlx5.ini      | 1 +
>   doc/guides/rel_notes/release_21_05.rst | 5 +++++
>   3 files changed, 7 insertions(+)
> 
> diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini
> index 8046bd1..49aaf17 100644
> --- a/doc/guides/nics/features/default.ini
> +++ b/doc/guides/nics/features/default.ini
> @@ -39,6 +39,7 @@ DCB                  =
>   VLAN filter          =
>   Flow control         =
>   Flow API             =
> +Flow dump            =

Hi Haifei,

I don't think "flow dump" is important enough to be listed in the feature list, 
I am for not adding it.
Comparing the one line above item, "Flow API", this one is small and indeed 
subset of it.

>   Rate limitation      =
>   Traffic mirroring    =
>   Inline crypto        =
> diff --git a/doc/guides/nics/features/mlx5.ini b/doc/guides/nics/features/mlx5.ini
> index ddd131d..3c5fcff 100644
> --- a/doc/guides/nics/features/mlx5.ini
> +++ b/doc/guides/nics/features/mlx5.ini
> @@ -29,6 +29,7 @@ SR-IOV               = Y
>   VLAN filter          = Y
>   Flow control         = Y
>   Flow API             = Y
> +Flow dump            = Y
>   CRC offload          = Y
>   VLAN offload         = Y
>   L3 checksum offload  = Y
> diff --git a/doc/guides/rel_notes/release_21_05.rst b/doc/guides/rel_notes/release_21_05.rst
> index a0b9079..e3ae470 100644
> --- a/doc/guides/rel_notes/release_21_05.rst
> +++ b/doc/guides/rel_notes/release_21_05.rst
> @@ -174,6 +174,8 @@ New Features
>       ``dpdk-testpmd -- --eth-link-speed N``
>     * Added command to display Rx queue used descriptor count.
>       ``show port (port_id) rxq (queue_id) desc used count``
> +  * Added command to dump internal representation information of single flow.
> +    ``flow dump (port_id) rule (rule_id)``
>   
>   
>   Removed Items
> @@ -207,6 +209,9 @@ API Changes
>      Also, make sure to start the actual text at the margin.
>      =======================================================
>   
> +* ethdev: Added a rte_flow pointer parameter to the function
> +  ``rte_flow_dev_dump()`` allowing dump for single flow.
> +
>   * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
>     from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
>     and confusion with the transport layer security term.
> 

Can you please distribute the release notes updates to the patches that 
introduces the change? So there should be a separate release notes update patch.

Thanks.
Haifei Luo April 14, 2021, 8:25 a.m. UTC | #2
Hi Ferruh,
   Okay ,  I will remove it from feature list. Thank you.

-----Original Message-----
From: Ferruh Yigit <ferruh.yigit@intel.com> 
Sent: Wednesday, April 14, 2021 4:24 PM
To: Haifei Luo <haifeil@nvidia.com>; dev@dpdk.org
Cc: Ori Kam <orika@nvidia.com>; Slava Ovsiienko <viacheslavo@nvidia.com>; Raslan Darawsheh <rasland@nvidia.com>; Xueming(Steven) Li <xuemingl@nvidia.com>; ajit.khaparde@broadcom.com; Matan Azrad <matan@nvidia.com>; Shahaf Shuler <shahafs@nvidia.com>
Subject: Re: [PATCH v3 3/3] doc: add single flow dump to guides

External email: Use caution opening links or attachments


On 4/14/2021 7:13 AM, Haifei Luo wrote:
> Add "Flow dump" in features/default.ini and features/mlx5.ini.
> Add testpmd CLI and API changes in release_notes.
>
> Signed-off-by: Haifei Luo <haifeil@nvidia.com>
> ---
>   doc/guides/nics/features/default.ini   | 1 +
>   doc/guides/nics/features/mlx5.ini      | 1 +
>   doc/guides/rel_notes/release_21_05.rst | 5 +++++
>   3 files changed, 7 insertions(+)
>
> diff --git a/doc/guides/nics/features/default.ini 
> b/doc/guides/nics/features/default.ini
> index 8046bd1..49aaf17 100644
> --- a/doc/guides/nics/features/default.ini
> +++ b/doc/guides/nics/features/default.ini
> @@ -39,6 +39,7 @@ DCB                  =
>   VLAN filter          =
>   Flow control         =
>   Flow API             =
> +Flow dump            =

Hi Haifei,

I don't think "flow dump" is important enough to be listed in the feature list, I am for not adding it.
Comparing the one line above item, "Flow API", this one is small and indeed subset of it.

>   Rate limitation      =
>   Traffic mirroring    =
>   Inline crypto        =
> diff --git a/doc/guides/nics/features/mlx5.ini 
> b/doc/guides/nics/features/mlx5.ini
> index ddd131d..3c5fcff 100644
> --- a/doc/guides/nics/features/mlx5.ini
> +++ b/doc/guides/nics/features/mlx5.ini
> @@ -29,6 +29,7 @@ SR-IOV               = Y
>   VLAN filter          = Y
>   Flow control         = Y
>   Flow API             = Y
> +Flow dump            = Y
>   CRC offload          = Y
>   VLAN offload         = Y
>   L3 checksum offload  = Y
> diff --git a/doc/guides/rel_notes/release_21_05.rst 
> b/doc/guides/rel_notes/release_21_05.rst
> index a0b9079..e3ae470 100644
> --- a/doc/guides/rel_notes/release_21_05.rst
> +++ b/doc/guides/rel_notes/release_21_05.rst
> @@ -174,6 +174,8 @@ New Features
>       ``dpdk-testpmd -- --eth-link-speed N``
>     * Added command to display Rx queue used descriptor count.
>       ``show port (port_id) rxq (queue_id) desc used count``
> +  * Added command to dump internal representation information of single flow.
> +    ``flow dump (port_id) rule (rule_id)``
>
>
>   Removed Items
> @@ -207,6 +209,9 @@ API Changes
>      Also, make sure to start the actual text at the margin.
>      =======================================================
>
> +* ethdev: Added a rte_flow pointer parameter to the function
> +  ``rte_flow_dev_dump()`` allowing dump for single flow.
> +
>   * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
>     from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
>     and confusion with the transport layer security term.
>

Can you please distribute the release notes updates to the patches that introduces the change? So there should be a separate release notes update patch.

Thanks.
Haifei Luo April 14, 2021, 10 a.m. UTC | #3
Hi Ferruh,
      "Can you please distribute the release notes updates to the patches that introduces the change?"
okay

-----Original Message-----
From: Ferruh Yigit <ferruh.yigit@intel.com> 
Sent: Wednesday, April 14, 2021 4:24 PM
To: Haifei Luo <haifeil@nvidia.com>; dev@dpdk.org
Cc: Ori Kam <orika@nvidia.com>; Slava Ovsiienko <viacheslavo@nvidia.com>; Raslan Darawsheh <rasland@nvidia.com>; Xueming(Steven) Li <xuemingl@nvidia.com>; ajit.khaparde@broadcom.com; Matan Azrad <matan@nvidia.com>; Shahaf Shuler <shahafs@nvidia.com>
Subject: Re: [PATCH v3 3/3] doc: add single flow dump to guides

External email: Use caution opening links or attachments


On 4/14/2021 7:13 AM, Haifei Luo wrote:
> Add "Flow dump" in features/default.ini and features/mlx5.ini.
> Add testpmd CLI and API changes in release_notes.
>
> Signed-off-by: Haifei Luo <haifeil@nvidia.com>
> ---
>   doc/guides/nics/features/default.ini   | 1 +
>   doc/guides/nics/features/mlx5.ini      | 1 +
>   doc/guides/rel_notes/release_21_05.rst | 5 +++++
>   3 files changed, 7 insertions(+)
>
> diff --git a/doc/guides/nics/features/default.ini 
> b/doc/guides/nics/features/default.ini
> index 8046bd1..49aaf17 100644
> --- a/doc/guides/nics/features/default.ini
> +++ b/doc/guides/nics/features/default.ini
> @@ -39,6 +39,7 @@ DCB                  =
>   VLAN filter          =
>   Flow control         =
>   Flow API             =
> +Flow dump            =

Hi Haifei,

I don't think "flow dump" is important enough to be listed in the feature list, I am for not adding it.
Comparing the one line above item, "Flow API", this one is small and indeed subset of it.

>   Rate limitation      =
>   Traffic mirroring    =
>   Inline crypto        =
> diff --git a/doc/guides/nics/features/mlx5.ini 
> b/doc/guides/nics/features/mlx5.ini
> index ddd131d..3c5fcff 100644
> --- a/doc/guides/nics/features/mlx5.ini
> +++ b/doc/guides/nics/features/mlx5.ini
> @@ -29,6 +29,7 @@ SR-IOV               = Y
>   VLAN filter          = Y
>   Flow control         = Y
>   Flow API             = Y
> +Flow dump            = Y
>   CRC offload          = Y
>   VLAN offload         = Y
>   L3 checksum offload  = Y
> diff --git a/doc/guides/rel_notes/release_21_05.rst 
> b/doc/guides/rel_notes/release_21_05.rst
> index a0b9079..e3ae470 100644
> --- a/doc/guides/rel_notes/release_21_05.rst
> +++ b/doc/guides/rel_notes/release_21_05.rst
> @@ -174,6 +174,8 @@ New Features
>       ``dpdk-testpmd -- --eth-link-speed N``
>     * Added command to display Rx queue used descriptor count.
>       ``show port (port_id) rxq (queue_id) desc used count``
> +  * Added command to dump internal representation information of single flow.
> +    ``flow dump (port_id) rule (rule_id)``
>
>
>   Removed Items
> @@ -207,6 +209,9 @@ API Changes
>      Also, make sure to start the actual text at the margin.
>      =======================================================
>
> +* ethdev: Added a rte_flow pointer parameter to the function
> +  ``rte_flow_dev_dump()`` allowing dump for single flow.
> +
>   * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
>     from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
>     and confusion with the transport layer security term.
>

Can you please distribute the release notes updates to the patches that introduces the change? So there should be a separate release notes update patch.

Thanks.
diff mbox series

Patch

diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini
index 8046bd1..49aaf17 100644
--- a/doc/guides/nics/features/default.ini
+++ b/doc/guides/nics/features/default.ini
@@ -39,6 +39,7 @@  DCB                  =
 VLAN filter          =
 Flow control         =
 Flow API             =
+Flow dump            =
 Rate limitation      =
 Traffic mirroring    =
 Inline crypto        =
diff --git a/doc/guides/nics/features/mlx5.ini b/doc/guides/nics/features/mlx5.ini
index ddd131d..3c5fcff 100644
--- a/doc/guides/nics/features/mlx5.ini
+++ b/doc/guides/nics/features/mlx5.ini
@@ -29,6 +29,7 @@  SR-IOV               = Y
 VLAN filter          = Y
 Flow control         = Y
 Flow API             = Y
+Flow dump            = Y
 CRC offload          = Y
 VLAN offload         = Y
 L3 checksum offload  = Y
diff --git a/doc/guides/rel_notes/release_21_05.rst b/doc/guides/rel_notes/release_21_05.rst
index a0b9079..e3ae470 100644
--- a/doc/guides/rel_notes/release_21_05.rst
+++ b/doc/guides/rel_notes/release_21_05.rst
@@ -174,6 +174,8 @@  New Features
     ``dpdk-testpmd -- --eth-link-speed N``
   * Added command to display Rx queue used descriptor count.
     ``show port (port_id) rxq (queue_id) desc used count``
+  * Added command to dump internal representation information of single flow.
+    ``flow dump (port_id) rule (rule_id)``
 
 
 Removed Items
@@ -207,6 +209,9 @@  API Changes
    Also, make sure to start the actual text at the margin.
    =======================================================
 
+* ethdev: Added a rte_flow pointer parameter to the function
+  ``rte_flow_dev_dump()`` allowing dump for single flow.
+
 * eal: The experimental TLS API added in ``rte_thread.h`` has been renamed
   from ``rte_thread_tls_*`` to ``rte_thread_*`` to avoid naming redundancy
   and confusion with the transport layer security term.