[dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

Mcnamara, John john.mcnamara at intel.com
Thu Feb 8 13:27:23 CET 2018


> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Thursday, February 8, 2018 11:39 AM
> To: Zhao1, Wei <wei.zhao1 at intel.com>; dev at dpdk.org
> Cc: Mcnamara, John <john.mcnamara at intel.com>
> Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for
> igb
> 
> On 2/2/2018 3:29 AM, Wei Zhao wrote:
> > 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.
> >
> > Signed-off-by: Wei Zhao <wei.zhao1 at intel.com>
> >
> > ---
> >
> > v2:
> > -change code indentation style.
> >
> > v3:
> > -add more details for igb feature.
> > ---
> >  doc/guides/nics/igb.rst | 38 ++++++++++++++++++++++++++++++++++++++
> 
> This file is not in the index, so you won't able select file from side bar
> and will be very hard to access this document unless you know the url,
> also producing a warning for same thing:
> 
> .../doc/guides/nics/igb.rst: WARNING: document isn't included in any
> toctree


I missed that in the review. Can you fix that in the merge?

John



More information about the dev mailing list