Re: [dpdk-dev] [PATCH v6 2/2] doc: add guide for debug and troubleshoot

["Varghese, Vipin" <vipin.varghese@intel.com>]

Thanks John, I will look into the same ASAP.

> -----Original Message-----
> From: Mcnamara, John
> Sent: Monday, February 25, 2019 5:05 PM
> To: Varghese, Vipin <vipin.varghese@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>; thomas@monjalon.net; Yigit, Ferruh
> <ferruh.yigit@intel.com>; shreyansh.jain@nxp.com; dev@dpdk.org
> Cc: Padubidri, Sanjay A <sanjay.padubidri@intel.com>; Patel, Amol
> <amol.patel@intel.com>
> Subject: RE: [PATCH v6 2/2] doc: add guide for debug and troubleshoot
> 
> 
> 
> > -----Original Message-----
> > From: Varghese, Vipin
> > Sent: Tuesday, February 19, 2019 3:57 PM
> > To: Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> > <marko.kovacevic@intel.com>; thomas@monjalon.net; Yigit, Ferruh
> > <ferruh.yigit@intel.com>; shreyansh.jain@nxp.com; dev@dpdk.org
> > Cc: Padubidri, Sanjay A <sanjay.padubidri@intel.com>; Patel, Amol
> > <amol.patel@intel.com>; Varghese, Vipin <vipin.varghese@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