diff mbox series

[1/6] doc: fix underlines too long in testpmd documentation

Message ID 20221110141506.335016-2-michaelba@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Andrew Rybchenko
Headers
Series doc: some fixes |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Michael Baum Nov. 10, 2022, 2:15 p.m. UTC 
  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(-)

Comments

Zhang, Yuying Nov. 11, 2022, 7:07 a.m. UTC | #1 
> -----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
diff mbox series

Patch

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.