From: Thomas Monjalon <thomas@monjalon.net>
To: Nicolas Chautru <nicolas.chautru@intel.com>,
John McNamara <john.mcnamara@intel.com>,
Marko Kovacevic <marko.kovacevic@intel.com>
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH v3] doc: fix PDF build of bbdev prog guide
Date: Fri, 19 Jul 2019 00:01:01 +0200 [thread overview]
Message-ID: <20190718220101.16900-1-thomas@monjalon.net> (raw)
In-Reply-To: <1563431079-14170-1-git-send-email-nicolas.chautru@intel.com>
Some machine (like on dpdk.org) may fail to build the prog guide PDF
because of a table characher being "+" instead of "|".
Some figure references are also fixed with automatic numbering.
Fixes: 3f3f608142cf ("doc: update bbdev guide for 5GNR operations")
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
v3: fix only the bad character and keep complex table (Thomas)
v2: try simpler table and fix figure refs (Nicolas)
v1: remove some table rows (Thomas)
---
doc/guides/prog_guide/bbdev.rst | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst
index ef05dcb4c..d49184967 100644
--- a/doc/guides/prog_guide/bbdev.rst
+++ b/doc/guides/prog_guide/bbdev.rst
@@ -809,7 +809,7 @@ The LDPC encode parameters are set out in the table below.
+----------------+------------+-------------------------------------------------------+
| |r |index of the first CB in the inbound mbuf data |
+----------------+------------+-------------------------------------------------------+
-+ +c_ab +number of CBs that use Ea before switching to Eb |
+| |c_ab |number of CBs that use Ea before switching to Eb |
+----------------+------------+-------------------------------------------------------+
| |ea |Ea, length of the RM output sequence in bits, r < cab |
+----------------+------------+-------------------------------------------------------+
@@ -865,8 +865,9 @@ calculated by BBDEV before signalling to the driver.
The number of CBs in the group should not be confused with ``c``, the
total number of CBs in the full TB (``C`` as per 3GPP TS 38.212 section 5.2.2)
-Figure 13.1 above showing the Turbo encoding of CBs using BBDEV
-interface in TB-mode is also valid for LDPC encode.
+Figure :numref:`figure_turbo_tb_encode` above
+showing the Turbo encoding of CBs using BBDEV interface in TB-mode
+is also valid for LDPC encode.
BBDEV LDPC Decode Operation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1077,8 +1078,9 @@ total number of CBs in the full TB (``C`` as per 3GPP TS 38.212 section 5.2.2)
The ``length`` is total size of the CBs inclusive of any CRC24A and CRC24B in
case they were appended by the application.
-Figure 13.2 above showing the Turbo decoding of CBs using BBDEV
-interface in TB-mode is also valid for LDPC decode.
+Figure :numref:`figure_turbo_tb_decode` above
+showing the Turbo decoding of CBs using BBDEV interface in TB-mode
+is also valid for LDPC decode.
Sample code
--
2.21.0
next prev parent reply other threads:[~2019-07-18 22:01 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-18 6:24 [dpdk-dev] [PATCH] " Nicolas Chautru
2019-07-18 13:53 ` Thomas Monjalon
2019-07-18 14:43 ` Chautru, Nicolas
2019-07-18 15:01 ` Thomas Monjalon
2019-07-18 15:09 ` Chautru, Nicolas
2019-07-18 13:57 ` Thomas Monjalon
2019-07-18 14:51 ` Chautru, Nicolas
2019-07-18 15:05 ` Thomas Monjalon
2019-07-18 21:49 ` Thomas Monjalon
2019-07-18 22:01 ` Thomas Monjalon [this message]
2019-07-18 22:04 ` [dpdk-dev] [PATCH v3] " 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=20190718220101.16900-1-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=nicolas.chautru@intel.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).