DPDK patches and discussions
 help / color / mirror / Atom feed
* [PATCH 0/6] doc: some fixes
@ 2022-11-10 14:15 Michael Baum
  2022-11-10 14:15 ` [PATCH 1/6] doc: fix underlines too long in testpmd documentation Michael Baum
                   ` (6 more replies)
  0 siblings, 7 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-10 14:15 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko

Some doc fixes in testpmd doc and release notes.

Michael Baum (6):
  doc: fix underlines too long in testpmd documentation
  doc: fix the colon type in listing aged flow rules
  doc: fix miss blank line in testpmd flow syntax doc
  doc: fix miss blank line in release notes
  doc: add mlx5 HWS aging support to release notes
  doc: add ethdev pre-config flags to release notes

 doc/guides/rel_notes/release_22_11.rst      |  8 ++++++++
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 11 ++++++-----
 2 files changed, 14 insertions(+), 5 deletions(-)

-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH 1/6] doc: fix underlines too long in testpmd documentation
  2022-11-10 14:15 [PATCH 0/6] doc: some fixes Michael Baum
@ 2022-11-10 14:15 ` Michael Baum
  2022-11-11  7:07   ` Zhang, Yuying
  2022-11-10 14:15 ` [PATCH 2/6] doc: fix the colon type in listing aged flow rules Michael Baum
                   ` (5 subsequent siblings)
  6 siblings, 1 reply; 17+ messages in thread
From: Michael Baum @ 2022-11-10 14:15 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, jackmin, dongz, stable

In testpmd documentation, there are two underlines which should not
match the length of the text above.

This patch update them to be align with the guideline [1].

[1]
https://doc.dpdk.org/guides/contributing/documentation.html#section-headers

Fixes: a69c335d56b5 ("doc: add flow dump command in testpmd guide")
Fixes: 0e459ffa0889 ("app/testpmd: support flow aging")
Cc: jackmin@mellanox.com
Cc: dongz@mellanox.com
Cc: stable@dpdk.org

Signed-off-by: Michael Baum <michaelba@nvidia.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 96c5ae0fe4..b5649d9d9a 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4240,7 +4240,7 @@ Disabling isolated mode::
  testpmd>
 
 Dumping HW internal information
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ``flow dump`` dumps the hardware's internal representation information of
 all flows. It is bound to ``rte_flow_dev_dump()``::
@@ -4256,7 +4256,7 @@ Otherwise, it will complain error occurred::
    Caught error type [...] ([...]): [...]
 
 Listing and destroying aged flow rules
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH 2/6] doc: fix the colon type in listing aged flow rules
  2022-11-10 14:15 [PATCH 0/6] doc: some fixes Michael Baum
  2022-11-10 14:15 ` [PATCH 1/6] doc: fix underlines too long in testpmd documentation Michael Baum
@ 2022-11-10 14:15 ` Michael Baum
  2022-11-10 14:15 ` [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax doc Michael Baum
                   ` (4 subsequent siblings)
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-10 14:15 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, dongz, stable

In testpmd documentation, for listing aged-out flow rules there is some
boxes of examples.

In Sphinx syntax, those boxes are achieved by "::" before. However,
in two places it uses ":" instead and the example looks like a regular
text.

This patch replace the ":" with "::" to get code box.

Fixes: 0e459ffa0889 ("app/testpmd: support flow aging")
Cc: dongz@mellanox.com
Cc: stable@dpdk.org

Signed-off-by: Michael Baum <michaelba@nvidia.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index b5649d9d9a..b5fea1396c 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4259,7 +4259,7 @@ Listing and destroying aged flow rules
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
-and ``destroy`` parameter can be used to destroy those flow rules in PMD.
+and ``destroy`` parameter can be used to destroy those flow rules in PMD::
 
    flow aged {port_id} [destroy]
 
@@ -4294,7 +4294,7 @@ will be ID 3, ID 1, ID 0::
    1       0       0       i--
    0       0       0       i--
 
-If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
+If attach ``destroy`` parameter, the command will destroy all the list aged flow rules::
 
    testpmd> flow aged 0 destroy
    Port 0 total aged flows: 4
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax doc
  2022-11-10 14:15 [PATCH 0/6] doc: some fixes Michael Baum
  2022-11-10 14:15 ` [PATCH 1/6] doc: fix underlines too long in testpmd documentation Michael Baum
  2022-11-10 14:15 ` [PATCH 2/6] doc: fix the colon type in listing aged flow rules Michael Baum
@ 2022-11-10 14:15 ` Michael Baum
  2022-11-11  7:02   ` Zhang, Yuying
  2022-11-10 14:15 ` [PATCH 4/6] doc: fix miss blank line in release notes Michael Baum
                   ` (3 subsequent siblings)
  6 siblings, 1 reply; 17+ messages in thread
From: Michael Baum @ 2022-11-10 14:15 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, akozyrev, stable

In flow syntax documentation, there is example for create pattern
template.

Before the example, miss a blank line causing it to look regular bold
text.
In addition, inside the example, it uses tab instead of spaces which
expand the indentation in one line.

This patch adds the blank line and replaces tab with spaces.

Fixes: 04cc665fab38 ("app/testpmd: add flow template management")
Cc: akozyrev@nvidia.com
Cc: stable@dpdk.org

Signed-off-by: Michael Baum <michaelba@nvidia.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index b5fea1396c..0037506a79 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -2894,9 +2894,10 @@ following sections.
        [meters_number {number}] [flags {number}]
 
 - Create a pattern template::
+
    flow pattern_template {port_id} create [pattern_template_id {id}]
        [relaxed {boolean}] [ingress] [egress] [transfer]
-	   template {item} [/ {item} [...]] / end
+       template {item} [/ {item} [...]] / end
 
 - Destroy a pattern template::
 
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH 4/6] doc: fix miss blank line in release notes
  2022-11-10 14:15 [PATCH 0/6] doc: some fixes Michael Baum
                   ` (2 preceding siblings ...)
  2022-11-10 14:15 ` [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax doc Michael Baum
@ 2022-11-10 14:15 ` Michael Baum
  2022-11-10 14:15 ` [PATCH 5/6] doc: add mlx5 HWS aging support to " Michael Baum
                   ` (2 subsequent siblings)
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-10 14:15 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, bingz, suanmingm

The NVIDIA mlx5 driver inside 22.11 release notes, lists all features
support for queue-based async HW steering.

Before the list, miss a blank line causing it to look regular text line.

This patch adds the blank line as well.

Fixes: ddb68e47331e ("net/mlx5: add extended metadata mode for HWS")
Fixes: 0f4aa72b99da ("net/mlx5: support flow modify field with HWS")
Cc: bingz@nvidia.com
Cc: suanmingm@nvidia.com

Signed-off-by: Michael Baum <michaelba@nvidia.com>
---
 doc/guides/rel_notes/release_22_11.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index 61f7d4d0aa..7c50af38c6 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -185,6 +185,7 @@ New Features
 * **Updated NVIDIA mlx5 driver.**
 
   * Added full support for queue-based async HW steering.
+
     - Support of FDB.
     - Support of control flow and isolate mode.
     - Support of conntrack.
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH 5/6] doc: add mlx5 HWS aging support to release notes
  2022-11-10 14:15 [PATCH 0/6] doc: some fixes Michael Baum
                   ` (3 preceding siblings ...)
  2022-11-10 14:15 ` [PATCH 4/6] doc: fix miss blank line in release notes Michael Baum
@ 2022-11-10 14:15 ` Michael Baum
  2022-11-10 14:15 ` [PATCH 6/6] doc: add ethdev pre-config flags " Michael Baum
  2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-10 14:15 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, michaelba

Add to 22.11 release note the NVIDIA mlx5 HWS aging support.

Fixes: 04a4de756e14 ("net/mlx5: support flow age action with HWS")
Cc: michaelba@nvidia.com

Signed-off-by: Michael Baum <michaelba@nvidia.com>
---
 doc/guides/rel_notes/release_22_11.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index 7c50af38c6..c27980a1aa 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -190,6 +190,7 @@ New Features
     - Support of control flow and isolate mode.
     - Support of conntrack.
     - Support of counter.
+    - Support of aging.
     - Support of meter.
     - Support of modify fields.
 
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH 6/6] doc: add ethdev pre-config flags to release notes
  2022-11-10 14:15 [PATCH 0/6] doc: some fixes Michael Baum
                   ` (4 preceding siblings ...)
  2022-11-10 14:15 ` [PATCH 5/6] doc: add mlx5 HWS aging support to " Michael Baum
@ 2022-11-10 14:15 ` Michael Baum
  2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-10 14:15 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, michaelba

Add to release notes:
1. Flags field in pre-configuration structure and strict-queue flag.

Fixes: dcc9a80c20b8 ("ethdev: add strict queue to pre-configuration flow hints")
Cc: michaelba@nvidia.com

Signed-off-by: Michael Baum <michaelba@nvidia.com>
---
 doc/guides/rel_notes/release_22_11.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index c27980a1aa..dfce601f8a 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -108,6 +108,12 @@ New Features
   Each flag has a corresponding capability flag
   in ``struct rte_eth_hairpin_queue_cap``.
 
+* **Added strict queue to pre-configuration flow hints.**
+
+  * Added flags option to ``rte_flow_configure`` and ``rte_flow_info_get``.
+  * Added ``RTE_FLOW_PORT_FLAG_STRICT_QUEUE`` flag to indicate all operations
+    for a given flow rule will strictly happen on the same queue.
+
 * **Added configuration for asynchronous flow connection tracking.**
 
   Added connection tracking action number hint to ``rte_flow_configure``
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* RE: [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax doc
  2022-11-10 14:15 ` [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax doc Michael Baum
@ 2022-11-11  7:02   ` Zhang, Yuying
  0 siblings, 0 replies; 17+ messages in thread
From: Zhang, Yuying @ 2022-11-11  7:02 UTC (permalink / raw)
  To: Michael Baum, dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Singh, Aman Deep,
	Andrew Rybchenko, akozyrev, stable



> -----Original Message-----
> From: Michael Baum <michaelba@nvidia.com>
> Sent: 2022年11月10日 22:15
> To: dev@dpdk.org
> Cc: Matan Azrad <matan@nvidia.com>; Thomas Monjalon
> <thomas@monjalon.net>; Raslan Darawsheh <rasland@nvidia.com>; Singh,
> Aman Deep <aman.deep.singh@intel.com>; Zhang, Yuying
> <yuying.zhang@intel.com>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; akozyrev@nvidia.com; stable@dpdk.org
> Subject: [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax doc
> 
> In flow syntax documentation, there is example for create pattern template.
> 
> Before the example, miss a blank line causing it to look regular bold text.
> In addition, inside the example, it uses tab instead of spaces which expand the
> indentation in one line.
> 
> This patch adds the blank line and replaces tab with spaces.
> 
> Fixes: 04cc665fab38 ("app/testpmd: add flow template management")
> Cc: akozyrev@nvidia.com
> Cc: stable@dpdk.org
> 
> Signed-off-by: Michael Baum <michaelba@nvidia.com>
Acked-by: Yuying Zhang <yuying.zhang@intel.com>

> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index b5fea1396c..0037506a79 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -2894,9 +2894,10 @@ following sections.
>         [meters_number {number}] [flags {number}]
> 
>  - Create a pattern template::
> +
>     flow pattern_template {port_id} create [pattern_template_id {id}]
>         [relaxed {boolean}] [ingress] [egress] [transfer]
> -	   template {item} [/ {item} [...]] / end
> +       template {item} [/ {item} [...]] / end
> 
>  - Destroy a pattern template::
> 
> --
> 2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* RE: [PATCH 1/6] doc: fix underlines too long in testpmd documentation
  2022-11-10 14:15 ` [PATCH 1/6] doc: fix underlines too long in testpmd documentation Michael Baum
@ 2022-11-11  7:07   ` Zhang, Yuying
  0 siblings, 0 replies; 17+ messages in thread
From: Zhang, Yuying @ 2022-11-11  7:07 UTC (permalink / raw)
  To: Michael Baum, dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Singh, Aman Deep,
	Andrew Rybchenko, jackmin, dongz, stable



> -----Original Message-----
> From: Michael Baum <michaelba@nvidia.com>
> Sent: 2022年11月10日 22:15
> To: dev@dpdk.org
> Cc: Matan Azrad <matan@nvidia.com>; Thomas Monjalon
> <thomas@monjalon.net>; Raslan Darawsheh <rasland@nvidia.com>; Singh,
> Aman Deep <aman.deep.singh@intel.com>; Zhang, Yuying
> <yuying.zhang@intel.com>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; jackmin@mellanox.com;
> dongz@mellanox.com; stable@dpdk.org
> Subject: [PATCH 1/6] doc: fix underlines too long in testpmd documentation
> 
> In testpmd documentation, there are two underlines which should not match the
> length of the text above.
> 
> This patch update them to be align with the guideline [1].
> 
> [1]
> https://doc.dpdk.org/guides/contributing/documentation.html#section-headers
> 
> Fixes: a69c335d56b5 ("doc: add flow dump command in testpmd guide")
> Fixes: 0e459ffa0889 ("app/testpmd: support flow aging")
> Cc: jackmin@mellanox.com
> Cc: dongz@mellanox.com
> Cc: stable@dpdk.org
> 
> Signed-off-by: Michael Baum <michaelba@nvidia.com>
Acked-by: Yuying Zhang <Yuying.Zhang@intel.com>

> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index 96c5ae0fe4..b5649d9d9a 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -4240,7 +4240,7 @@ Disabling isolated mode::
>   testpmd>
> 
>  Dumping HW internal information
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
>  ``flow dump`` dumps the hardware's internal representation information of  all
> flows. It is bound to ``rte_flow_dev_dump()``::
> @@ -4256,7 +4256,7 @@ Otherwise, it will complain error occurred::
>     Caught error type [...] ([...]): [...]
> 
>  Listing and destroying aged flow rules
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
>  ``flow aged`` simply lists aged flow rules be get from api
> ``rte_flow_get_aged_flows``,  and ``destroy`` parameter can be used to destroy
> those flow rules in PMD.
> --
> 2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH v2 0/6] doc: some fixes
  2022-11-10 14:15 [PATCH 0/6] doc: some fixes Michael Baum
                   ` (5 preceding siblings ...)
  2022-11-10 14:15 ` [PATCH 6/6] doc: add ethdev pre-config flags " Michael Baum
@ 2022-11-16 12:56 ` Michael Baum
  2022-11-16 12:56   ` [PATCH v2 1/6] doc: fix underlines too long in testpmd documentation Michael Baum
                     ` (6 more replies)
  6 siblings, 7 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-16 12:56 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko

Some doc fixes in testpmd doc and release notes.

The first 3 were splited from commit [1] after discussion.

[1]
https://patchwork.dpdk.org/project/dpdk/patch/20221019144904.2543586-3-michaelba@nvidia.com/

v2:
- rebase.
- add "Reviewed-by" and "Acked-by" lables.
- add detailes to cover letter.

Michael Baum (6):
  doc: fix underlines too long in testpmd documentation
  doc: fix the colon type in listing aged flow rules
  doc: fix miss blank line in testpmd flow syntax doc
  doc: fix miss blank line in release notes
  doc: add mlx5 HWS aging support to release notes
  doc: add ethdev pre-config flags to release notes

 doc/guides/rel_notes/release_22_11.rst      |  8 ++++++++
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 11 ++++++-----
 2 files changed, 14 insertions(+), 5 deletions(-)

-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH v2 1/6] doc: fix underlines too long in testpmd documentation
  2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
@ 2022-11-16 12:56   ` Michael Baum
  2022-11-16 12:56   ` [PATCH v2 2/6] doc: fix the colon type in listing aged flow rules Michael Baum
                     ` (5 subsequent siblings)
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-16 12:56 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, jackmin, dongz, stable,
	Yuying Zhang

In testpmd documentation, there are two underlines which should not
match the length of the text above.

This patch update them to be align with the guideline [1].

[1]
https://doc.dpdk.org/guides/contributing/documentation.html#section-headers

Fixes: a69c335d56b5 ("doc: add flow dump command in testpmd guide")
Fixes: 0e459ffa0889 ("app/testpmd: support flow aging")
Cc: jackmin@mellanox.com
Cc: dongz@mellanox.com
Cc: stable@dpdk.org

Signed-off-by: Michael Baum <michaelba@nvidia.com>
Reviewed-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Yuying Zhang <Yuying.Zhang@intel.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 96c5ae0fe4..b5649d9d9a 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4240,7 +4240,7 @@ Disabling isolated mode::
  testpmd>
 
 Dumping HW internal information
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ``flow dump`` dumps the hardware's internal representation information of
 all flows. It is bound to ``rte_flow_dev_dump()``::
@@ -4256,7 +4256,7 @@ Otherwise, it will complain error occurred::
    Caught error type [...] ([...]): [...]
 
 Listing and destroying aged flow rules
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH v2 2/6] doc: fix the colon type in listing aged flow rules
  2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
  2022-11-16 12:56   ` [PATCH v2 1/6] doc: fix underlines too long in testpmd documentation Michael Baum
@ 2022-11-16 12:56   ` Michael Baum
  2022-11-16 12:56   ` [PATCH v2 3/6] doc: fix miss blank line in testpmd flow syntax doc Michael Baum
                     ` (4 subsequent siblings)
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-16 12:56 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, dongz, stable

In testpmd documentation, for listing aged-out flow rules there is some
boxes of examples.

In Sphinx syntax, those boxes are achieved by "::" before. However,
in two places it uses ":" instead and the example looks like a regular
text.

This patch replace the ":" with "::" to get code box.

Fixes: 0e459ffa0889 ("app/testpmd: support flow aging")
Cc: dongz@mellanox.com
Cc: stable@dpdk.org

Signed-off-by: Michael Baum <michaelba@nvidia.com>
Reviewed-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index b5649d9d9a..b5fea1396c 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -4259,7 +4259,7 @@ Listing and destroying aged flow rules
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
-and ``destroy`` parameter can be used to destroy those flow rules in PMD.
+and ``destroy`` parameter can be used to destroy those flow rules in PMD::
 
    flow aged {port_id} [destroy]
 
@@ -4294,7 +4294,7 @@ will be ID 3, ID 1, ID 0::
    1       0       0       i--
    0       0       0       i--
 
-If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
+If attach ``destroy`` parameter, the command will destroy all the list aged flow rules::
 
    testpmd> flow aged 0 destroy
    Port 0 total aged flows: 4
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH v2 3/6] doc: fix miss blank line in testpmd flow syntax doc
  2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
  2022-11-16 12:56   ` [PATCH v2 1/6] doc: fix underlines too long in testpmd documentation Michael Baum
  2022-11-16 12:56   ` [PATCH v2 2/6] doc: fix the colon type in listing aged flow rules Michael Baum
@ 2022-11-16 12:56   ` Michael Baum
  2022-11-16 12:56   ` [PATCH v2 4/6] doc: fix miss blank line in release notes Michael Baum
                     ` (3 subsequent siblings)
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-16 12:56 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, akozyrev, stable, Yuying Zhang

In flow syntax documentation, there is example for create pattern
template.

Before the example, miss a blank line causing it to look regular bold
text.
In addition, inside the example, it uses tab instead of spaces which
expand the indentation in one line.

This patch adds the blank line and replaces tab with spaces.

Fixes: 04cc665fab38 ("app/testpmd: add flow template management")
Cc: akozyrev@nvidia.com
Cc: stable@dpdk.org

Signed-off-by: Michael Baum <michaelba@nvidia.com>
Reviewed-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Yuying Zhang <Yuying.Zhang@intel.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index b5fea1396c..0037506a79 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -2894,9 +2894,10 @@ following sections.
        [meters_number {number}] [flags {number}]
 
 - Create a pattern template::
+
    flow pattern_template {port_id} create [pattern_template_id {id}]
        [relaxed {boolean}] [ingress] [egress] [transfer]
-	   template {item} [/ {item} [...]] / end
+       template {item} [/ {item} [...]] / end
 
 - Destroy a pattern template::
 
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH v2 4/6] doc: fix miss blank line in release notes
  2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
                     ` (2 preceding siblings ...)
  2022-11-16 12:56   ` [PATCH v2 3/6] doc: fix miss blank line in testpmd flow syntax doc Michael Baum
@ 2022-11-16 12:56   ` Michael Baum
  2022-11-16 12:56   ` [PATCH v2 5/6] doc: add mlx5 HWS aging support to " Michael Baum
                     ` (2 subsequent siblings)
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-16 12:56 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, bingz, suanmingm

The NVIDIA mlx5 driver inside 22.11 release notes, lists all features
support for queue-based async HW steering.

Before the list, miss a blank line causing it to look regular text line.

This patch adds the blank line as well.

Fixes: ddb68e47331e ("net/mlx5: add extended metadata mode for HWS")
Fixes: 0f4aa72b99da ("net/mlx5: support flow modify field with HWS")
Cc: bingz@nvidia.com
Cc: suanmingm@nvidia.com

Signed-off-by: Michael Baum <michaelba@nvidia.com>
Reviewed-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/release_22_11.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index 5e091403ad..aa857e8203 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -185,6 +185,7 @@ New Features
 * **Updated NVIDIA mlx5 driver.**
 
   * Added full support for queue-based async HW steering.
+
     - Support of FDB.
     - Support of control flow and isolate mode.
     - Support of conntrack.
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH v2 5/6] doc: add mlx5 HWS aging support to release notes
  2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
                     ` (3 preceding siblings ...)
  2022-11-16 12:56   ` [PATCH v2 4/6] doc: fix miss blank line in release notes Michael Baum
@ 2022-11-16 12:56   ` Michael Baum
  2022-11-16 12:56   ` [PATCH v2 6/6] doc: add ethdev pre-config flags " Michael Baum
  2022-11-21 21:29   ` [PATCH v2 0/6] doc: some fixes Thomas Monjalon
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-16 12:56 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, michaelba

Add to 22.11 release note the NVIDIA mlx5 HWS aging support.

Fixes: 04a4de756e14 ("net/mlx5: support flow age action with HWS")
Cc: michaelba@nvidia.com

Signed-off-by: Michael Baum <michaelba@nvidia.com>
Reviewed-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/release_22_11.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index aa857e8203..ba8b97c09a 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -190,6 +190,7 @@ New Features
     - Support of control flow and isolate mode.
     - Support of conntrack.
     - Support of counter.
+    - Support of aging.
     - Support of meter.
     - Support of modify fields.
 
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* [PATCH v2 6/6] doc: add ethdev pre-config flags to release notes
  2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
                     ` (4 preceding siblings ...)
  2022-11-16 12:56   ` [PATCH v2 5/6] doc: add mlx5 HWS aging support to " Michael Baum
@ 2022-11-16 12:56   ` Michael Baum
  2022-11-21 21:29   ` [PATCH v2 0/6] doc: some fixes Thomas Monjalon
  6 siblings, 0 replies; 17+ messages in thread
From: Michael Baum @ 2022-11-16 12:56 UTC (permalink / raw)
  To: dev
  Cc: Matan Azrad, Thomas Monjalon, Raslan Darawsheh, Aman Singh,
	Yuying Zhang, Andrew Rybchenko, michaelba

Add to release notes:
1. Flags field in pre-configuration structure and strict-queue flag.

Fixes: dcc9a80c20b8 ("ethdev: add strict queue to pre-configuration flow hints")
Cc: michaelba@nvidia.com

Signed-off-by: Michael Baum <michaelba@nvidia.com>
Reviewed-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/release_22_11.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst
index ba8b97c09a..3dee012636 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -108,6 +108,12 @@ New Features
   Each flag has a corresponding capability flag
   in ``struct rte_eth_hairpin_queue_cap``.
 
+* **Added strict queue to pre-configuration flow hints.**
+
+  * Added flags option to ``rte_flow_configure`` and ``rte_flow_info_get``.
+  * Added ``RTE_FLOW_PORT_FLAG_STRICT_QUEUE`` flag to indicate all operations
+    for a given flow rule will strictly happen on the same queue.
+
 * **Added configuration for asynchronous flow connection tracking.**
 
   Added connection tracking action number hint to ``rte_flow_configure``
-- 
2.25.1


^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [PATCH v2 0/6] doc: some fixes
  2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
                     ` (5 preceding siblings ...)
  2022-11-16 12:56   ` [PATCH v2 6/6] doc: add ethdev pre-config flags " Michael Baum
@ 2022-11-21 21:29   ` Thomas Monjalon
  6 siblings, 0 replies; 17+ messages in thread
From: Thomas Monjalon @ 2022-11-21 21:29 UTC (permalink / raw)
  To: Michael Baum
  Cc: dev, Matan Azrad, Raslan Darawsheh, Aman Singh, Yuying Zhang,
	Andrew Rybchenko

> Michael Baum (6):
>   doc: fix underlines too long in testpmd documentation
>   doc: fix the colon type in listing aged flow rules
>   doc: fix miss blank line in testpmd flow syntax doc
>   doc: fix miss blank line in release notes
>   doc: add mlx5 HWS aging support to release notes
>   doc: add ethdev pre-config flags to release notes

Applied, thanks.




^ permalink raw reply	[flat|nested] 17+ messages in thread

end of thread, other threads:[~2022-11-21 21:30 UTC | newest]

Thread overview: 17+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-10 14:15 [PATCH 0/6] doc: some fixes Michael Baum
2022-11-10 14:15 ` [PATCH 1/6] doc: fix underlines too long in testpmd documentation Michael Baum
2022-11-11  7:07   ` Zhang, Yuying
2022-11-10 14:15 ` [PATCH 2/6] doc: fix the colon type in listing aged flow rules Michael Baum
2022-11-10 14:15 ` [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax doc Michael Baum
2022-11-11  7:02   ` Zhang, Yuying
2022-11-10 14:15 ` [PATCH 4/6] doc: fix miss blank line in release notes Michael Baum
2022-11-10 14:15 ` [PATCH 5/6] doc: add mlx5 HWS aging support to " Michael Baum
2022-11-10 14:15 ` [PATCH 6/6] doc: add ethdev pre-config flags " Michael Baum
2022-11-16 12:56 ` [PATCH v2 0/6] doc: some fixes Michael Baum
2022-11-16 12:56   ` [PATCH v2 1/6] doc: fix underlines too long in testpmd documentation Michael Baum
2022-11-16 12:56   ` [PATCH v2 2/6] doc: fix the colon type in listing aged flow rules Michael Baum
2022-11-16 12:56   ` [PATCH v2 3/6] doc: fix miss blank line in testpmd flow syntax doc Michael Baum
2022-11-16 12:56   ` [PATCH v2 4/6] doc: fix miss blank line in release notes Michael Baum
2022-11-16 12:56   ` [PATCH v2 5/6] doc: add mlx5 HWS aging support to " Michael Baum
2022-11-16 12:56   ` [PATCH v2 6/6] doc: add ethdev pre-config flags " Michael Baum
2022-11-21 21:29   ` [PATCH v2 0/6] doc: some fixes Thomas Monjalon

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).