From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 727EBB436 for ; Wed, 8 Jun 2016 19:14:36 +0200 (CEST) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga103.fm.intel.com with ESMTP; 08 Jun 2016 10:14:08 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.26,440,1459839600"; d="scan'208";a="997962464" Received: from irsmsx154.ger.corp.intel.com ([163.33.192.96]) by fmsmga002.fm.intel.com with ESMTP; 08 Jun 2016 10:14:06 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.240]) by IRSMSX154.ger.corp.intel.com ([169.254.12.28]) with mapi id 14.03.0248.002; Wed, 8 Jun 2016 18:14:06 +0100 From: "Mcnamara, John" To: Neil Horman , "dev@dpdk.org" CC: "Richardson, Bruce" , Thomas Monjalon , Stephen Hemminger , Panu Matilainen Thread-Topic: [dpdk-dev] [PATCHv6 7/7] doc: Add prog_guide section documenting pmdinfo script Thread-Index: AQHRu0T9i9EEj5WOb0aUh4Cex4KXOp/f2fVA Date: Wed, 8 Jun 2016 17:14:05 +0000 Message-ID: References: <1463431287-4551-1-git-send-email-nhorman@tuxdriver.com> <1464703068-2924-1-git-send-email-nhorman@tuxdriver.com> <1464703068-2924-8-git-send-email-nhorman@tuxdriver.com> In-Reply-To: <1464703068-2924-8-git-send-email-nhorman@tuxdriver.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNGM4ZjMzNjAtYmM1Ny00ODAyLTlkMTEtYWFjOThlNzJiMDQ2IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IjREcmhvcys3bHlvUDR0TnZnRGVwUks2TjF2SzZJNUY0dG5BUHJXNFpleTQ9In0= x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCHv6 7/7] doc: Add prog_guide section documenting pmdinfo script X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 08 Jun 2016 17:14:36 -0000 > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Neil Horman > Sent: Tuesday, May 31, 2016 2:58 PM > To: dev@dpdk.org > Cc: Neil Horman ; Richardson, Bruce > ; Thomas Monjalon = ; > Stephen Hemminger ; Panu Matilainen > > Subject: [dpdk-dev] [PATCHv6 7/7] doc: Add prog_guide section documenting > pmdinfo script >=20 > Information on pmdinfogen may be useful to 3rd party driver developers. > Include documentation on what it does Hi, There are some trailing whitespace warnings on merge. Some other, minor, comments below. >=20 > +.. _Internally_Generated_Build_Tools The target needs a colon at the end to make it valid: .. _Internally_Generated_Build_Tools: > + > +buildtools/pmdinfogen This might be better with some distinguishing highlighting, either ``buildtools/pmdinfogen`` or **buildtools/pmdinfogen**. > +pmdinfogen scans an object (.o) file for various well known symbol Instances of pmdinfogen would be better as a fixed width ``pmdinfogen``. > +names. These well know symbol names are defined by various macros and > +used to export important information about hardware support and usage > +for pmd files. for instance the macro: s/know/known s/for/For > +These strings can then be searched for by external tools to determine > +the hardware support of a given library or application Missing full stop. Apart from these minor changes: Acked-by: John McNamara