From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <john.mcnamara@intel.com>
Received: from mga17.intel.com (mga17.intel.com [192.55.52.151])
 by dpdk.org (Postfix) with ESMTP id C09A947CE
 for <dev@dpdk.org>; Mon, 25 Feb 2019 12:34:35 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga004.fm.intel.com ([10.253.24.48])
 by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 25 Feb 2019 03:34:34 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.58,411,1544515200"; d="scan'208";a="147066615"
Received: from irsmsx106.ger.corp.intel.com ([163.33.3.31])
 by fmsmga004.fm.intel.com with ESMTP; 25 Feb 2019 03:34:33 -0800
Received: from irsmsx103.ger.corp.intel.com ([169.254.3.199]) by
 IRSMSX106.ger.corp.intel.com ([169.254.8.53]) with mapi id 14.03.0415.000;
 Mon, 25 Feb 2019 11:34:33 +0000
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>
Thread-Topic: [PATCH v6 2/2] doc: add guide for debug and troubleshoot
Thread-Index: AQHUyGvS/D08tMD/6UiTVXNgvt+7CaXwag/A
Date: Mon, 25 Feb 2019 11:34:32 +0000
Message-ID: <B27915DBBA3421428155699D51E4CFE23F56086D@IRSMSX103.ger.corp.intel.com>
References: <20190121104144.67365-2-vipin.varghese@intel.com>
 <20190219155719.89443-1-vipin.varghese@intel.com>
 <20190219155719.89443-3-vipin.varghese@intel.com>
In-Reply-To: <20190219155719.89443-3-vipin.varghese@intel.com>
Accept-Language: en-GB, en-US
Content-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
x-ctpclassification: CTP_NT
x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiY2MyODE2OTItODQ3Yy00YTMzLWE0MzItMjU5MmQwYmQyZjA5IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiTmxNM3hTNWxNWTcxNE5kZHQyRGdRckxMS3Z4RXdwQmNUYmhYZkh0ZTlEMUdzTkR3dXZOM3RhZ2F3R1lZTWIrVyJ9
dlp-product: dlpe-windows
dlp-version: 11.0.400.15
dlp-reaction: no-action
x-originating-ip: [163.33.239.182]
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Subject: Re: [dpdk-dev] [PATCH v6 2/2] doc: add guide for debug and
	troubleshoot
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Mon, 25 Feb 2019 11:34:36 -0000



> -----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
>=20
> Add user guide on debugging and troubleshooting for common issues and
> bottleneck found in the sample application model.
>=20

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:=20
    WARNING: Title underline too short.

Also, in 2 places the ".. note::" directive is used without a space=20
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