diff mbox series

[v3] doc: fix PDF build of bbdev prog guide

Message ID 20190718220101.16900-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Headers
Series [v3] doc: fix PDF build of bbdev prog guide |

Checks

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

Commit Message

Thomas Monjalon July 18, 2019, 10:01 p.m. UTC 
  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(-)

Comments

Thomas Monjalon July 18, 2019, 10:04 p.m. UTC | #1 
19/07/2019 00:01, Thomas Monjalon:
> 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)
> ---

Applied quickly
diff mbox series

Patch

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