From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by dpdk.org (Postfix) with ESMTP id 8E656A84E for ; Thu, 1 Feb 2018 10:13:53 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 01 Feb 2018 01:13:52 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,443,1511856000"; d="scan'208";a="15071828" Received: from irsmsx152.ger.corp.intel.com ([163.33.192.66]) by orsmga006.jf.intel.com with ESMTP; 01 Feb 2018 01:13:51 -0800 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.197]) by IRSMSX152.ger.corp.intel.com ([169.254.6.52]) with mapi id 14.03.0319.002; Thu, 1 Feb 2018 09:13:50 +0000 From: "Mcnamara, John" To: "Zhao1, Wei" , "dev@dpdk.org" CC: "Lu, Wenzhuo" Thread-Topic: [PATCH v2] doc: add a user guidance document for igb Thread-Index: AQHTmnEuUyfnu8AsGEiziNMVNI+8nKOPP++g Date: Thu, 1 Feb 2018 09:13:50 +0000 Message-ID: References: <20180131084014.133620-1-wei.zhao1@intel.com> <20180131084710.133820-1-wei.zhao1@intel.com> In-Reply-To: <20180131084710.133820-1-wei.zhao1@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: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiZmJmMjAxZTctNGZlMi00NTc5LTk2MzQtZWVmZWVhZjc1MDM2IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6IjRMbk56aFMyRkViUlZHMyszMDROM21LRjROdzE2MUUyQmdBZVBoR2NGaU09In0= dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action 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] [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: Thu, 01 Feb 2018 09:13:54 -0000 > -----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 >=20 > 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 > +=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. 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