From: Stephen Hemminger <stephen@networkplumber.org>
To: john.mcnamara@intel.com, marko.kovacevic@intel.com, wisamm@mellanox.com
Cc: dev@dpdk.org, Stephen Hemminger <stephen@networkplumber.org>
Subject: [dpdk-dev] [PATCH] doc/flow-perf: fix section headings
Date: Sat, 5 Sep 2020 20:39:52 -0700 [thread overview]
Message-ID: <20200906033952.24895-1-stephen@networkplumber.org> (raw)
The flow-perf documentation was using multiple section headings
in one document. This caused the documentation tree display in
index to make it appear as multiple pages rather than sub-sections
in one page.
Change to use subsections and subsubsections.
Fixes: bf3688f1e816 ("app/flow-perf: add insertion rate calculation")
Cc: wisamm@mellanox.com
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
doc/guides/tools/flow-perf.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/guides/tools/flow-perf.rst b/doc/guides/tools/flow-perf.rst
index cdedaf9a97d4..247dcf26703e 100644
--- a/doc/guides/tools/flow-perf.rst
+++ b/doc/guides/tools/flow-perf.rst
@@ -18,7 +18,7 @@ give different flow each time, and all other items will have open masks.
Known Limitations
-=================
+-----------------
The current version has limitations which can be removed in future:
@@ -33,7 +33,7 @@ The app supports single and multi core performance measurements.
Compiling the Application
-=========================
+-------------------------
The ``test-flow-perf`` application is compiled as part of the main compilation
of the DPDK libraries and tools.
@@ -42,10 +42,10 @@ Refer to the DPDK Getting Started Guides for details.
Running the Application
-=======================
+-----------------------
EAL Command-line Options
-------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^
Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>`
or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for
@@ -53,7 +53,7 @@ a list of available EAL command-line options.
Flow Performance Options
-------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^
The following are the command-line options for the flow performance application.
They must be separated from the EAL options, shown in the previous section,
--
2.27.0
next reply other threads:[~2020-09-06 3:40 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-06 3:39 Stephen Hemminger [this message]
2020-09-06 7:31 ` Wisam Monther
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=20200906033952.24895-1-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=wisamm@mellanox.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).