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] doc: fix PDF build of bbdev prog guide
Date: Thu, 18 Jul 2019 00:01:23 +0200 [thread overview]
Message-ID: <20190717220123.6165-1-thomas@monjalon.net> (raw)
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
next reply other threads:[~2019-07-17 22:01 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-17 22:01 Thomas Monjalon [this message]
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
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=20190717220123.6165-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).