[dpdk-dev] [PATCH] doc: fix PDF build of bbdev prog guide
Thomas Monjalon
thomas at monjalon.net
Thu Jul 18 00:01:23 CEST 2019
Some machine (like on dpdk.org) may fail to build the prog guide PDF
because of the complex table inserted in the bbdev chapter.
Fixes: 3f3f608142cf ("doc: update bbdev guide for 5GNR operations")
Cc: nicolas.chautru at intel.com
Signed-off-by: Thomas Monjalon <thomas at monjalon.net>
---
Anyway all the documentation about the API details should be removed.
The guide is expected to give an understanding of the whole design,
not replacing the details maintained in the doxygen comments.
While at refactoring this chapter, the hardcoded references to some
section or figure numbers must be replaced by dynamic references.
None of this cleanup is done in this patch.
Please try to rework it quickly before 19.08-rc2,
otherwise this patch will be applied to avoid being annoyed again
(as for -rc1) when generating the documentation on dpdk.org.
---
doc/guides/prog_guide/bbdev.rst | 16 ----------------
1 file changed, 16 deletions(-)
diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst
index ef05dcb4c..f023778bd 100644
--- a/doc/guides/prog_guide/bbdev.rst
+++ b/doc/guides/prog_guide/bbdev.rst
@@ -1008,22 +1008,6 @@ The LDPC decode parameters are set out in the table below.
+----------------+--------------------------------------------------------------------+
|op_flags |bitmask of all active operation capabilities |
+----------------+--------------------------------------------------------------------+
-|**cb_params** |code block specific parameters (code block mode only) |
-+----------------+------------+-------------------------------------------------------+
-| |e |E, length of the rate matched output sequence in bits |
-+----------------+------------+-------------------------------------------------------+
-|**tb_params** | transport block specific parameters (transport block mode only) |
-+----------------+------------+-------------------------------------------------------+
-| |c |number of CBs in the TB or partial TB |
-+----------------+------------+-------------------------------------------------------+
-| |r |index of the first CB in the inbound mbuf data |
-+----------------+------------+-------------------------------------------------------+
-| |c_ab |number of CBs that use Ea before switching to Eb |
-+----------------+------------+-------------------------------------------------------+
-| |ea |Ea, length of the RM output sequence in bits, r < cab |
-+----------------+------------+-------------------------------------------------------+
-| |eb |Eb, length of the RM output sequence in bits r >= cab |
-+----------------+------------+-------------------------------------------------------+
The mbuf input ``input`` encoded CB data is mandatory for all BBDEV PMDs
and is the Virtual Circular Buffer data stream with null padding.
--
2.21.0
More information about the dev
mailing list