From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id 14D41532C for ; Fri, 2 Feb 2018 04:38:46 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 01 Feb 2018 19:38:46 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,445,1511856000"; d="scan'208";a="16393087" Received: from kmsmsx155.gar.corp.intel.com ([172.21.73.106]) by fmsmga002.fm.intel.com with ESMTP; 01 Feb 2018 19:38:45 -0800 Received: from pgsmsx103.gar.corp.intel.com ([169.254.2.31]) by KMSMSX155.gar.corp.intel.com ([169.254.15.143]) with mapi id 14.03.0319.002; Fri, 2 Feb 2018 11:38:44 +0800 From: "Zhao1, Wei" To: "Mcnamara, John" , "dev@dpdk.org" CC: "Lu, Wenzhuo" Thread-Topic: [PATCH v2] doc: add a user guidance document for igb Thread-Index: AQHTmnEvEdgyaLj6k0CnsSmSbY+Fe6OOvvMAgAG6qyA= Date: Fri, 2 Feb 2018 03:38:43 +0000 Message-ID: References: <20180131084014.133620-1-wei.zhao1@intel.com> <20180131084710.133820-1-wei.zhao1@intel.com> In-Reply-To: Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-originating-ip: [172.30.20.205] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v2] doc: add a user guidance document for igb X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 02 Feb 2018 03:38:47 -0000 Hi, John A new v3 commit. https://dpdk.org/dev/patchwork/patch/34863/ > -----Original Message----- > From: Mcnamara, John > Sent: Thursday, February 1, 2018 5:14 PM > To: Zhao1, Wei ; dev@dpdk.org > Cc: Lu, Wenzhuo > Subject: RE: [PATCH v2] doc: add a user guidance document for igb >=20 >=20 >=20 > > -----Original Message----- > > From: Zhao1, Wei > > Sent: Wednesday, January 31, 2018 8:47 AM > > To: dev@dpdk.org > > Cc: Mcnamara, John ; Lu, Wenzhuo > > ; Zhao1, Wei > > 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. >=20 > Hi, >=20 > Thanks for the doc. It is something we should have had a while ago. > Some comments below. >=20 > > +.. BSD LICENSE > > + Copyright(c) 2018 Intel Corporation. All rights reserved. > > + All rights reserved. > > + >=20 > You should probably use an SPDX header here. >=20 >=20 >=20 > > +IGB Poll Mode Driver > > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > > + > > +The IGB PMD (librte_pmd_e1000) provides poll mode driver support. >=20 > Maybe use something a bit more descriptive here like: >=20 > The IGB PMD (``librte_pmd_e1000``) provides poll mode driver support for > Intel 1GbE nics. >=20 >=20 >=20 > > + > > +Features > > +-------- > > + > > +Features of the IGB PMD are: >=20 > Could you fill in some of these as a bullet list like: >=20 > Features of the IGB PMD are: >=20 > * VLAN > * VxLAN > * IEEE 1588 > * etc. >=20 > The rest of the doc looks good. >=20 > John >=20