DPDK patches and discussions
 help / color / mirror / Atom feed
From: "Zhao1, Wei" <wei.zhao1@intel.com>
To: "Mcnamara, John" <john.mcnamara@intel.com>,
	"dev@dpdk.org" <dev@dpdk.org>
Cc: "Lu, Wenzhuo" <wenzhuo.lu@intel.com>
Subject: Re: [dpdk-dev] [PATCH v2] doc: add a user guidance document for igb
Date: Fri, 2 Feb 2018 03:38:43 +0000	[thread overview]
Message-ID: <A2573D2ACFCADC41BB3BE09C6DE313CA07CAED06@PGSMSX103.gar.corp.intel.com> (raw)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE23EEA1672@IRSMSX103.ger.corp.intel.com>

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 <wei.zhao1@intel.com>; dev@dpdk.org
> Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>
> Subject: RE: [PATCH v2] doc: add a user guidance document for igb
> 
> 
> 
> > -----Original Message-----
> > From: Zhao1, Wei
> > Sent: Wednesday, January 31, 2018 8:47 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>; Lu, Wenzhuo
> > <wenzhuo.lu@intel.com>; Zhao1, Wei <wei.zhao1@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
> 

  reply	other threads:[~2018-02-02  3:38 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-31  8:40 [dpdk-dev] [PATCH] " Wei Zhao
2018-01-31  8:47 ` [dpdk-dev] [PATCH v2] " Wei Zhao
2018-02-01  9:13   ` Mcnamara, John
2018-02-02  3:38     ` Zhao1, Wei [this message]
2018-02-02  3:29   ` [dpdk-dev] [PATCH v3] " Wei Zhao
2018-02-05  9:34     ` Mcnamara, John
2018-02-07  7:12       ` Zhang, Helin
2018-02-08 13:49         ` Ferruh Yigit
2018-02-08 11:38     ` Ferruh Yigit
2018-02-08 12:27       ` Mcnamara, John
2018-02-08 12:30         ` Ferruh Yigit
2018-02-13  3:30         ` Zhao1, Wei

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=A2573D2ACFCADC41BB3BE09C6DE313CA07CAED06@PGSMSX103.gar.corp.intel.com \
    --to=wei.zhao1@intel.com \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=wenzhuo.lu@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).