[dpdk-dev] [PATCH] doc/flow-perf: fix section headings

Stephen Hemminger stephen at networkplumber.org
Sun Sep 6 05:39:52 CEST 2020


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 at mellanox.com
Signed-off-by: Stephen Hemminger <stephen at 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



More information about the dev mailing list