From: Thomas Monjalon <thomas@monjalon.net>
To: Amr Mokhtar <amr.mokhtar@intel.com>,
John McNamara <john.mcnamara@intel.com>,
Marko Kovacevic <marko.kovacevic@intel.com>
Cc: dev@dpdk.org, stable@dpdk.org
Subject: [dpdk-dev] [PATCH] doc: fix heading levels in bbdev test guide
Date: Mon, 15 Apr 2019 13:58:38 +0200 [thread overview]
Message-ID: <20190415115838.6316-1-thomas@monjalon.net> (raw)
Message-ID: <20190415115838.b6ugZVlRm3aM5rPQdT_evzHEJxdCuse-hbkBuZ8GDk4@z> (raw)
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(-)
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``
--
2.21.0
next reply other threads:[~2019-04-15 11:59 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-15 11:58 Thomas Monjalon [this message]
2019-04-15 11:58 ` Thomas Monjalon
2019-04-16 14:38 ` Mcnamara, John
2019-04-16 14:38 ` Mcnamara, John
2019-04-22 22:27 ` Thomas Monjalon
2019-04-22 22:27 ` 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=20190415115838.6316-1-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=amr.mokhtar@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=stable@dpdk.org \
/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).