> -----Original Message----- > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Neil Horman > Sent: Tuesday, May 31, 2016 2:58 PM > To: dev at dpdk.org > Cc: Neil Horman <nhorman at tuxdriver.com>; Richardson, Bruce > <bruce.richardson at intel.com>; Thomas Monjalon <thomas.monjalon at > 6wind.com>; > Stephen Hemminger <stephen at networkplumber.org>; Panu Matilainen > <pmatilai at redhat.com> > Subject: [dpdk-dev] [PATCHv6 7/7] doc: Add prog_guide section documenting > pmdinfo script > > 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. > > +.. _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 <john.mcnamara at intel.com>