DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "Varghese, Vipin" <vipin.varghese@intel.com>,
	"Kovacevic, Marko" <marko.kovacevic@intel.com>,
	"thomas@monjalon.net" <thomas@monjalon.net>,
	"Yigit, Ferruh" <ferruh.yigit@intel.com>,
	"shreyansh.jain@nxp.com" <shreyansh.jain@nxp.com>,
	"dev@dpdk.org" <dev@dpdk.org>
Cc: "Padubidri, Sanjay A" <sanjay.padubidri@intel.com>,
	"Patel, Amol" <amol.patel@intel.com>
Subject: Re: [dpdk-dev] [PATCH v6 2/2] doc: add guide for debug and troubleshoot
Date: Mon, 25 Feb 2019 11:34:32 +0000	[thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE23F56086D@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <20190219155719.89443-3-vipin.varghese@intel.com>



> -----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

  reply	other threads:[~2019-02-25 11:34 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-26  7:08 [dpdk-dev] [PATCH v3 1/2] doc: add svg for debug and troubleshoot guide Vipin Varghese
2018-11-26  7:08 ` [dpdk-dev] [PATCH v3 2/2] doc: add guide for debug and troubleshoot Vipin Varghese
2019-01-04  6:37   ` Shreyansh Jain
2019-01-04  7:01     ` Varghese, Vipin
2019-01-16 14:54   ` [dpdk-dev] [PATCH v4 0/2] doci/howto: add debug and troubleshoot guide Vipin Varghese
2019-01-16 14:54     ` [dpdk-dev] [PATCH v4 1/2] doc: add svg for " Vipin Varghese
2019-01-16 14:54     ` [dpdk-dev] [PATCH v4 2/2] doc: add guide for debug and troubleshoot Vipin Varghese
2019-01-18 15:28       ` Kovacevic, Marko
2019-01-21  3:38         ` Varghese, Vipin
2019-01-21 10:41       ` [dpdk-dev] [PATCH v5 0/2] doc/howto: add debug and troubleshoot guide Vipin Varghese
2019-01-21 10:41         ` [dpdk-dev] [PATCH v5 1/2] doc: add svg for " Vipin Varghese
2019-01-28  1:08           ` Thomas Monjalon
2019-01-28 14:28             ` Varghese, Vipin
2019-02-19 15:57           ` [dpdk-dev] [PATCH v6 0/2] guide to debug and troubleshoot Vipin Varghese
2019-02-19 15:57             ` [dpdk-dev] [PATCH v6 1/2] doc: add svg for debug and troubleshoot guide Vipin Varghese
2019-02-19 15:57             ` [dpdk-dev] [PATCH v6 2/2] doc: add guide for debug and troubleshoot Vipin Varghese
2019-02-25 11:34               ` Mcnamara, John [this message]
2019-02-25 15:46                 ` Varghese, Vipin
2019-01-21 10:41         ` [dpdk-dev] [PATCH v5 " Vipin Varghese
2019-01-28  1:30           ` Thomas Monjalon
2019-01-28 14:51             ` Varghese, Vipin
2019-01-28 15:59               ` Thomas Monjalon
2019-02-08  9:21                 ` Varghese, Vipin

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=B27915DBBA3421428155699D51E4CFE23F56086D@IRSMSX103.ger.corp.intel.com \
    --to=john.mcnamara@intel.com \
    --cc=amol.patel@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=marko.kovacevic@intel.com \
    --cc=sanjay.padubidri@intel.com \
    --cc=shreyansh.jain@nxp.com \
    --cc=thomas@monjalon.net \
    --cc=vipin.varghese@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).