doc/flow-perf: fix section headings
PATCH 1/1 doc/flow-perf: fix section headings
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.
--- doc/guides/tools/flow-perf.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
doc/guides/tools/flow-perf.rst +5 -5
@@ -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,
Signature · 1 line
2.27.0
Quoted 12 lines
-----Original Message-----
From: Stephen Hemminger <[email protected]>
Sent: Sunday, September 6, 2020 6:40 AM
To: [email protected]; [email protected]; [email protected]
Cc: [email protected]; Stephen Hemminger <[email protected]>
Subject: [PATCH] doc/flow-perf: fix section headingsThe 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.
Quoted 5 lines
Change to use subsections and subsubsections.
Fixes bf3688f1e816 ("app/flow-perf: add insertion rate calculation")Signed-off-by Stephen Hemminger <[email protected]>
Hi Stephen,
Thanks for your fix,
I sent a patch with the fix that pending review from a week ago with the same fixes:
http://patches.dpdk.org/patch/76152/
BRs,
Wisam Jaddo