> -----Original Message-----
> From: Varghese, Vipin
> Sent: Tuesday, February 19, 2019 3:57 PM
> To: Mcnamara, John <john.mcnam...@intel.com>; Kovacevic, Marko
> <marko.kovace...@intel.com>; tho...@monjalon.net; Yigit, Ferruh
> <ferruh.yi...@intel.com>; shreyansh.j...@nxp.com; dev@dpdk.org
> Cc: Padubidri, Sanjay A <sanjay.padubi...@intel.com>; Patel, Amol
> <amol.pa...@intel.com>; Varghese, Vipin <vipin.vargh...@intel.com>
> Subject: [PATCH v6 2/2] doc: add guide for debug and troubleshoot
> 
> Add user guide on debugging and troubleshooting for common issues and
> bottleneck found in the sample application model.
> 

Hi,

Thanks for this. It is a good How-to doc and also a FAQ from customers.

A couple of minor comments.


There is a warning due to one of the header underlines not being long
enough:

    How to develop a custom code to debug?
    -------------------------------------
    /work/dpdk_docs/doc/guides/howto/debug_troubleshoot_guide.rst:444: 
    WARNING: Title underline too short.

Also, in 2 places the ".. note::" directive is used without a space 
after .., like below:

> +
> +..note::
> +
> +   It is difficult to cover all possible issues; in a single attempt.

Also, for the second note you may wish to indent it to the same level as
the previous paragraph.

But overall it looks good.

John

Reply via email to