doc: fix PDF build in octeontx2 guide

Message ID 20190710100147.30393-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: fix PDF build in octeontx2 guide |

Checks

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

Commit Message

Thomas Monjalon July 10, 2019, 10:01 a.m. UTC
  The unicode characters to draw the debugfs tree
may fail with some Latex distributions.
These characters are replaced with some ASCII equivalents.

Fixes: 14ad4f018453 ("doc: add Marvell OCTEON TX2 platform guide")

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/platform/octeontx2.rst | 96 +++++++++++++++----------------
 1 file changed, 48 insertions(+), 48 deletions(-)
  

Comments

Jerin Jacob Kollanukkaran July 10, 2019, 3:30 p.m. UTC | #1
> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Wednesday, July 10, 2019 3:32 PM
> To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Nithin Kumar
> Dabilpuram <ndabilpuram@marvell.com>; Vamsi Krishna Attunuru
> <vattunuru@marvell.com>; John McNamara <john.mcnamara@intel.com>;
> Marko Kovacevic <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org
> Subject: [PATCH] doc: fix PDF build in octeontx2 guide
> 
> The unicode characters to draw the debugfs tree may fail with some Latex
> distributions.
> These characters are replaced with some ASCII equivalents.
> 
> Fixes: 14ad4f018453 ("doc: add Marvell OCTEON TX2 platform guide")
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: Jerin Jacob <jerinj@marvell.com>
  
Thomas Monjalon July 10, 2019, 4:57 p.m. UTC | #2
> > The unicode characters to draw the debugfs tree may fail with some Latex
> > distributions.
> > These characters are replaced with some ASCII equivalents.
> > 
> > Fixes: 14ad4f018453 ("doc: add Marvell OCTEON TX2 platform guide")
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Acked-by: Jerin Jacob <jerinj@marvell.com>

Applied
  

Patch

diff --git a/doc/guides/platform/octeontx2.rst b/doc/guides/platform/octeontx2.rst
index 7d1fead3a..97c631f3b 100644
--- a/doc/guides/platform/octeontx2.rst
+++ b/doc/guides/platform/octeontx2.rst
@@ -214,54 +214,54 @@  The file structure under ``/sys/kernel/debug`` is as follows
 .. code-block:: console
 
         octeontx2/
-        ├── cgx
-        │   ├── cgx0
-        │   │   └── lmac0
-        │   │       └── stats
-        │   ├── cgx1
-        │   │   ├── lmac0
-        │   │   │   └── stats
-        │   │   └── lmac1
-        │   │       └── stats
-        │   └── cgx2
-        │       └── lmac0
-        │           └── stats
-        ├── cpt
-        │   ├── cpt_engines_info
-        │   ├── cpt_engines_sts
-        │   ├── cpt_err_info
-        │   ├── cpt_lfs_info
-        │   └── cpt_pc
-        ├──── nix
-        │   ├── cq_ctx
-        │   ├── ndc_rx_cache
-        │   ├── ndc_rx_hits_miss
-        │   ├── ndc_tx_cache
-        │   ├── ndc_tx_hits_miss
-        │   ├── qsize
-        │   ├── rq_ctx
-        │   ├── sq_ctx
-        │   └── tx_stall_hwissue
-        ├── npa
-        │   ├── aura_ctx
-        │   ├── ndc_cache
-        │   ├── ndc_hits_miss
-        │   ├── pool_ctx
-        │   └── qsize
-        ├── npc
-        │    ├── mcam_info
-        │    └── rx_miss_act_stats
-        ├── rsrc_alloc
-        └── sso
-             ├── hws
-             │   └── sso_hws_info
-             └── hwgrp
-                 ├── sso_hwgrp_aq_thresh
-                 ├── sso_hwgrp_iaq_walk
-                 ├── sso_hwgrp_pc
-                 ├── sso_hwgrp_free_list_walk
-                 ├── sso_hwgrp_ient_walk
-                 └── sso_hwgrp_taq_walk
+        |-- cgx
+        |   |-- cgx0
+        |   |   '-- lmac0
+        |   |       '-- stats
+        |   |-- cgx1
+        |   |   |-- lmac0
+        |   |   |   '-- stats
+        |   |   '-- lmac1
+        |   |       '-- stats
+        |   '-- cgx2
+        |       '-- lmac0
+        |           '-- stats
+        |-- cpt
+        |   |-- cpt_engines_info
+        |   |-- cpt_engines_sts
+        |   |-- cpt_err_info
+        |   |-- cpt_lfs_info
+        |   '-- cpt_pc
+        |---- nix
+        |   |-- cq_ctx
+        |   |-- ndc_rx_cache
+        |   |-- ndc_rx_hits_miss
+        |   |-- ndc_tx_cache
+        |   |-- ndc_tx_hits_miss
+        |   |-- qsize
+        |   |-- rq_ctx
+        |   |-- sq_ctx
+        |   '-- tx_stall_hwissue
+        |-- npa
+        |   |-- aura_ctx
+        |   |-- ndc_cache
+        |   |-- ndc_hits_miss
+        |   |-- pool_ctx
+        |   '-- qsize
+        |-- npc
+        |    |-- mcam_info
+        |    '-- rx_miss_act_stats
+        |-- rsrc_alloc
+        '-- sso
+             |-- hws
+             |   '-- sso_hws_info
+             '-- hwgrp
+                 |-- sso_hwgrp_aq_thresh
+                 |-- sso_hwgrp_iaq_walk
+                 |-- sso_hwgrp_pc
+                 |-- sso_hwgrp_free_list_walk
+                 |-- sso_hwgrp_ient_walk
+                 '-- sso_hwgrp_taq_walk
 
 RVU block LF allocation: