diff mbox

[dpdk-dev,v2] doc: fix bbdev test guide build

Message ID 20180124150745.11571-1-marko.kovacevic@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

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

Commit Message

Kovacevic, Marko Jan. 24, 2018, 3:07 p.m. UTC 
  Fix build issue with pdf guides. Some indentations in the bbdev test
application doc were causing build failures. Latex Log message:
 
    doc.log:! LaTeX Error: Too deeply nested.
   
Fixes: f714a18885a6 ("app/testbbdev: add test application for bbdev")
Cc: amr.mokhtar@intel.com
 

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
---

V2: Added more information into commit message
    about the issue

 doc/guides/tools/testbbdev.rst | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

Comments

Bruce Richardson Jan. 25, 2018, 4:48 p.m. UTC | #1 
On Wed, Jan 24, 2018 at 03:07:45PM +0000, Marko Kovacevic wrote:
> Fix build issue with pdf guides. Some indentations in the bbdev test
> application doc were causing build failures. Latex Log message:
>  
>     doc.log:! LaTeX Error: Too deeply nested.
>    
> Fixes: f714a18885a6 ("app/testbbdev: add test application for bbdev")
> Cc: amr.mokhtar@intel.com
>  
> 
> Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
> ---
> 
> V2: Added more information into commit message
>     about the issue

[Please use --in-reply-to to chain emails into a thread when sending v2's
and v3's etc. of patches.]

This fixes the errors I see with "make doc-guides-pdf" and the pdf
output looks ok for that section too.

Tested-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Thomas Monjalon Jan. 25, 2018, 5:45 p.m. UTC | #2 
25/01/2018 17:48, Bruce Richardson:
> On Wed, Jan 24, 2018 at 03:07:45PM +0000, Marko Kovacevic wrote:
> > Fix build issue with pdf guides. Some indentations in the bbdev test
> > application doc were causing build failures. Latex Log message:
> >  
> >     doc.log:! LaTeX Error: Too deeply nested.
> >    
> > Fixes: f714a18885a6 ("app/testbbdev: add test application for bbdev")
> > Cc: amr.mokhtar@intel.com
> >  
> > 
> > Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
> > ---
> > 
> > V2: Added more information into commit message
> >     about the issue
> 
> [Please use --in-reply-to to chain emails into a thread when sending v2's
> and v3's etc. of patches.]
> 
> This fixes the errors I see with "make doc-guides-pdf" and the pdf
> output looks ok for that section too.
> 
> Tested-by: Bruce Richardson <bruce.richardson@intel.com>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks
diff mbox

Patch

diff --git a/doc/guides/tools/testbbdev.rst b/doc/guides/tools/testbbdev.rst
index c7aac49..5c7112d 100644
--- a/doc/guides/tools/testbbdev.rst
+++ b/doc/guides/tools/testbbdev.rst
@@ -71,24 +71,26 @@  The following are the command-line options:
  Defines test cases to run. If not specified all available tests are run.
 
  The following tests can be run:
-  * unittest
+
+ * unittest
      Small unit tests witch check basic functionality of bbdev library.
-  * latency
+ * latency
      Test calculates three latency metrics:
-      * offload_latency_tc
+
+     * offload_latency_tc
          measures the cost of offloading enqueue and dequeue operations.
-      * offload_latency_empty_q_tc
+     * offload_latency_empty_q_tc
          measures the cost of offloading a dequeue operation from an empty queue.
          checks how long last dequeueing if there is no operations to dequeue
-      * operation_latency_tc
+     * operation_latency_tc
          measures the time difference from the first attempt to enqueue till the
          first successful dequeue.
-  * validation
+ * validation
      Test do enqueue on given vector and compare output after dequeueing.
-  * throughput
+ * throughput
      Test measures the achieved throughput on the available lcores.
      Results are printed in million operations per second and million bits per second.
-  * interrupt
+ * interrupt
      The same test as 'throughput' but uses interrupts instead of PMD to perform
      the dequeue.