DPDK patches and discussions
 help / color / mirror / Atom feed
From: Michael Baum <michaelba@nvidia.com>
To: <dev@dpdk.org>
Cc: Matan Azrad <matan@nvidia.com>,
	Thomas Monjalon <thomas@monjalon.net>,
	Raslan Darawsheh <rasland@nvidia.com>,
	Aman Singh <aman.deep.singh@intel.com>,
	Yuying Zhang <yuying.zhang@intel.com>,
	"Andrew Rybchenko" <andrew.rybchenko@oktetlabs.ru>,
	<jackmin@mellanox.com>, <dongz@mellanox.com>, <stable@dpdk.org>,
	Yuying Zhang <Yuying.Zhang@intel.com>
Subject: [PATCH v2 1/6] doc: fix underlines too long in testpmd documentation
Date: Wed, 16 Nov 2022 14:56:23 +0200	[thread overview]
Message-ID: <20221116125628.1026877-2-michaelba@nvidia.com> (raw)
In-Reply-To: <20221116125628.1026877-1-michaelba@nvidia.com>

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


  reply	other threads:[~2022-11-16 12:56 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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   ` Michael Baum [this message]
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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221116125628.1026877-2-michaelba@nvidia.com \
    --to=michaelba@nvidia.com \
    --cc=aman.deep.singh@intel.com \
    --cc=andrew.rybchenko@oktetlabs.ru \
    --cc=dev@dpdk.org \
    --cc=dongz@mellanox.com \
    --cc=jackmin@mellanox.com \
    --cc=matan@nvidia.com \
    --cc=rasland@nvidia.com \
    --cc=stable@dpdk.org \
    --cc=thomas@monjalon.net \
    --cc=yuying.zhang@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).