doc: some fixes
cover doc: some fixes
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(-)
Signature · 1 line
2.25.1
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
--- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/testpmd_app_ug/testpmd_funcs.rst +2 -2
@@ -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.
Signature · 1 line
2.25.1
RE: [PATCH 1/6] doc: fix underlines too long in testpmd documentation
Quoted 22 lines
-----Original Message-----
From: Michael Baum <[email protected]>
Sent: 2022年11月10日 22:15
To: [email protected]
Cc: Matan Azrad <[email protected]>; Thomas Monjalon <[email protected]>; Raslan Darawsheh <[email protected]>; Singh, Aman Deep <[email protected]>; Zhang, Yuying <[email protected]>; Andrew Rybchenko <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: [PATCH 1/6] doc: fix underlines too long in testpmd documentationIn 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
Quoted 7 lines
Fixes a69c335d56b5 ("doc: add flow dump command in testpmd guide")Fixes 0e459ffa0889 ("app/testpmd: support flow aging")Signed-off-by Michael Baum <[email protected]>
Quoted 30 lines
--- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)doc/guides/testpmd_app_ug/testpmd_funcs.rst +1
-1@@ -4240,7 +4240,7 @@ Disabling isolated mode:: testpmd> Dumping HW internal information -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``flow dump`` dumps the hardware's internal representation information of allflows. It is bound to ``rte_flow_dev_dump()``::
doc/guides/testpmd_app_ug/testpmd_funcs.rst +1
-1@@ -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
PATCH 2/6 doc: fix the colon type in listing aged flow rules
In reply to Michael BaumIn 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.
--- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/testpmd_app_ug/testpmd_funcs.rst +2 -2
@@ -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
Signature · 1 line
2.25.1
PATCH 3/6 doc: fix miss blank line in testpmd flow syntax doc
In reply to Michael BaumIn 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.
--- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
doc/guides/testpmd_app_ug/testpmd_funcs.rst +2 -1
@@ -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::
Signature · 1 line
2.25.1
RE: [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax doc
Quoted 19 lines
-----Original Message-----
From: Michael Baum <[email protected]>
Sent: 2022年11月10日 22:15
To: [email protected]
Cc: Matan Azrad <[email protected]>; Thomas Monjalon <[email protected]>; Raslan Darawsheh <[email protected]>; Singh, Aman Deep <[email protected]>; Zhang, Yuying <[email protected]>; Andrew Rybchenko <[email protected]>; [email protected]; [email protected]
Subject: [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax docIn 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.
Quoted 7 lines
This patch adds the blank line and replaces tab with spaces.
Fixes 04cc665fab38 ("app/testpmd: add flow template management")Signed-off-by Michael Baum <[email protected]>
Quoted 23 lines
--- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)doc/guides/testpmd_app_ug/testpmd_funcs.rst +2
-2@@ -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
PATCH 4/6 doc: fix miss blank line in release notes
In reply to Michael BaumThe 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.
--- doc/guides/rel_notes/release_22_11.rst | 1 + 1 file changed, 1 insertion(+)
doc/guides/rel_notes/release_22_11.rst +1 -0
@@ -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.
Signature · 1 line
2.25.1
PATCH 5/6 doc: add mlx5 HWS aging support to release notes
In reply to Michael BaumAdd to 22.11 release note the NVIDIA mlx5 HWS aging support.
--- doc/guides/rel_notes/release_22_11.rst | 1 + 1 file changed, 1 insertion(+)
doc/guides/rel_notes/release_22_11.rst +1 -0
@@ -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.
Signature · 1 line
2.25.1
PATCH 6/6 doc: add ethdev pre-config flags to release notes
In reply to Michael BaumAdd to release notes:
1. Flags field in pre-configuration structure and strict-queue flag.
--- doc/guides/rel_notes/release_22_11.rst | 6 ++++++ 1 file changed, 6 insertions(+)
doc/guides/rel_notes/release_22_11.rst +6 -0
@@ -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``
Signature · 1 line
2.25.1
v2 cover doc: some fixes
In reply to Michael BaumSome 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/[email protected]/
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(-)
Signature · 1 line
2.25.1
PATCH v2 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
--- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/testpmd_app_ug/testpmd_funcs.rst +2 -2
@@ -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.
Signature · 1 line
2.25.1
PATCH v2 2/6 doc: fix the colon type in listing aged flow rules
In reply to Michael BaumIn 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.
--- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/testpmd_app_ug/testpmd_funcs.rst +2 -2
@@ -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
Signature · 1 line
2.25.1
PATCH v2 3/6 doc: fix miss blank line in testpmd flow syntax doc
In reply to Michael BaumIn 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.
--- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
doc/guides/testpmd_app_ug/testpmd_funcs.rst +2 -1
@@ -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::
Signature · 1 line
2.25.1
PATCH v2 4/6 doc: fix miss blank line in release notes
In reply to Michael BaumThe 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.
--- doc/guides/rel_notes/release_22_11.rst | 1 + 1 file changed, 1 insertion(+)
doc/guides/rel_notes/release_22_11.rst +1 -0
@@ -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.
Signature · 1 line
2.25.1
PATCH v2 5/6 doc: add mlx5 HWS aging support to release notes
In reply to Michael BaumAdd to 22.11 release note the NVIDIA mlx5 HWS aging support.
--- doc/guides/rel_notes/release_22_11.rst | 1 + 1 file changed, 1 insertion(+)
doc/guides/rel_notes/release_22_11.rst +1 -0
@@ -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.
Signature · 1 line
2.25.1
PATCH v2 6/6 doc: add ethdev pre-config flags to release notes
In reply to Michael BaumAdd to release notes:
1. Flags field in pre-configuration structure and strict-queue flag.
--- doc/guides/rel_notes/release_22_11.rst | 6 ++++++ 1 file changed, 6 insertions(+)
doc/guides/rel_notes/release_22_11.rst +6 -0
@@ -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``
Signature · 1 line
2.25.1
Thomas Monjalon
AppliedQuoted 7 lines
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.