doc: fix heading levels in bbdev test guide

Message ID 20190415115838.6316-1-thomas@monjalon.net
State Accepted, archived
Headers show
Series
  • doc: fix heading levels in bbdev test guide
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Thomas Monjalon April 15, 2019, 11:58 a.m.
The section "Test Vector files" should not be at the same level as
the main title "dpdk-test-bbdev Application".

Fixes: f714a18885a6 ("app/testbbdev: add test application for bbdev")
Cc: stable@dpdk.org
Cc: amr.mokhtar@intel.com

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/tools/testbbdev.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Mcnamara, John April 16, 2019, 2:38 p.m. | #1
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Monday, April 15, 2019 12:59 PM
> To: Mokhtar, Amr <amr.mokhtar@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; stable@dpdk.org
> Subject: [PATCH] doc: fix heading levels in bbdev test guide
> 
> The section "Test Vector files" should not be at the same level as the
> main title "dpdk-test-bbdev Application".
> 
> Fixes: f714a18885a6 ("app/testbbdev: add test application for bbdev")
> Cc: stable@dpdk.org
> Cc: amr.mokhtar@intel.com

Good catch.

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon April 22, 2019, 10:27 p.m. | #2
> > The section "Test Vector files" should not be at the same level as the
> > main title "dpdk-test-bbdev Application".
> > 
> > Fixes: f714a18885a6 ("app/testbbdev: add test application for bbdev")
> > Cc: stable@dpdk.org
> > Cc: amr.mokhtar@intel.com
> 
> Good catch.
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied

Patch

diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst
index f3386472d..07da35e52 100644
--- a/doc/guides/tools/testbbdev.rst
+++ b/doc/guides/tools/testbbdev.rst
@@ -307,7 +307,7 @@  baseband_null device does not have to be defined explicitly as it is created by
 
 
 Test Vector files
-=================
+-----------------
 
 Test Vector files contain the data which is used to set turbo decoder/encoder
 parameters and buffers for validation purpose. New test vector files should be
@@ -316,7 +316,7 @@  the syntax of the test vector files is in the following section.
 
 
 Basic principles for test vector files
---------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Line started with ``#`` is treated as a comment and is ignored.
 
 If variable is a chain of values, values should be separated by a comma. If
@@ -351,7 +351,7 @@  documented in *rte_bbdev_op.h*
 
 
 Turbo decoder test vectors template
------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 For turbo decoder it has to be always set to ``RTE_BBDEV_OP_TURBO_DEC``
 
@@ -528,7 +528,7 @@  Following statuses can be used:
 
 
 Turbo encoder test vectors template
------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 For turbo encoder it has to be always set to ``RTE_BBDEV_OP_TURBO_ENC``