> -----Original Message----- > From: Zhao1, Wei > Sent: Wednesday, January 31, 2018 8:47 AM > To: dev@dpdk.org > Cc: Mcnamara, John <john.mcnam...@intel.com>; Lu, Wenzhuo > <wenzhuo...@intel.com>; Zhao1, Wei <wei.zh...@intel.com> > Subject: [PATCH v2] doc: add a user guidance document for igb > > This patch add a user guidance document specific for igb nic. > By now, a doc like ixgbe.rst is also needed by igb nic. So this patch add > igb.rst to record important information about igb, like feature supported > and known issues.
Hi, Thanks for the doc. It is something we should have had a while ago. Some comments below. > +.. BSD LICENSE > + Copyright(c) 2018 Intel Corporation. All rights reserved. > + All rights reserved. > + You should probably use an SPDX header here. > +IGB Poll Mode Driver > +==================== > + > +The IGB PMD (librte_pmd_e1000) provides poll mode driver support. Maybe use something a bit more descriptive here like: The IGB PMD (``librte_pmd_e1000``) provides poll mode driver support for Intel 1GbE nics. > + > +Features > +-------- > + > +Features of the IGB PMD are: Could you fill in some of these as a bullet list like: Features of the IGB PMD are: * VLAN * VxLAN * IEEE 1588 * etc. The rest of the doc looks good. John