DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] doc: fix PDF build of bbdev prog guide
@ 2019-07-17 22:01 Thomas Monjalon
  2019-07-18 13:33 ` Chautru, Nicolas
  0 siblings, 1 reply; 14+ messages in thread
From: Thomas Monjalon @ 2019-07-17 22:01 UTC (permalink / raw)
  To: Nicolas Chautru, John McNamara, Marko Kovacevic; +Cc: dev

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@intel.com

Signed-off-by: Thomas Monjalon <thomas@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


^ permalink raw reply	[flat|nested] 14+ messages in thread
* [dpdk-dev] [PATCH] doc: fix PDF build of bbdev prog guide
@ 2019-07-18  6:24 Nicolas Chautru
  2019-07-18 13:53 ` Thomas Monjalon
                   ` (2 more replies)
  0 siblings, 3 replies; 14+ messages in thread
From: Nicolas Chautru @ 2019-07-18  6:24 UTC (permalink / raw)
  To: dev, thomas, john.mcnamara, marko.kovacevic; +Cc: Nicolas Chautru

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")

Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
 doc/guides/prog_guide/bbdev.rst | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst
index ef05dcb..6c0bb3c 100644
--- a/doc/guides/prog_guide/bbdev.rst
+++ b/doc/guides/prog_guide/bbdev.rst
@@ -800,21 +800,21 @@ The LDPC encode 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  |
-+----------------+------------+-------------------------------------------------------+
++----------------+--------------------------------------------------------------------+
+|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 |
-+----------------+------------+-------------------------------------------------------+
++----------------+--------------------------------------------------------------------+
+|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`` is mandatory for all BBDEV PMDs and is the
 incoming code block or transport block data.
@@ -865,7 +865,7 @@ 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
+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,7 +1077,7 @@ 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
+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.
 
 
-- 
1.8.3.1


^ permalink raw reply	[flat|nested] 14+ messages in thread

end of thread, other threads:[~2019-07-18 21:49 UTC | newest]

Thread overview: 14+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-07-17 22:01 [dpdk-dev] [PATCH] doc: fix PDF build of bbdev prog guide Thomas Monjalon
2019-07-18 13:33 ` Chautru, Nicolas
2019-07-18 13:47   ` Thomas Monjalon
2019-07-18 14:59     ` Chautru, Nicolas
2019-07-18 15:09       ` Thomas Monjalon
2019-07-18  6:24 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

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).