[dpdk-dev] [PATCH v6] doc: document NIC features

Mcnamara, John john.mcnamara at intel.com
Fri Aug 4 13:11:05 CEST 2017


> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas at monjalon.net]
> Sent: Friday, August 4, 2017 10:32 AM
> To: Yigit, Ferruh <ferruh.yigit at intel.com>
> Cc: dev at dpdk.org; Mcnamara, John <john.mcnamara at intel.com>; Olivier Matz
> <olivier.matz at 6wind.com>
> Subject: Re: [dpdk-dev] [PATCH v6] doc: document NIC features
> 
> 04/08/2017 10:56, Ferruh Yigit:
> > On 8/3/2017 11:57 PM, Thomas Monjalon wrote:
> > > 01/08/2017 17:23, Ferruh Yigit:
> > >> +:orphan:
> > >> +
> > >> +.. _nic_overview_features:
> > >
> > > Why have you done an orphan page?
> > > I think it should be in doc/guides/nics/overview.rst
> >
> > There is a link from nics/overview.rst to this file. But this file is
> > not in the index and not making it orphan is causing a build warning.
> 
> But why creating a new page?
> It could be below the table in overview.rst.

For me it makes more sense on a separate page. It isn't really overview material.

However, thinking about it again I think that it should be included in the index
instead of using the :orphan: directive. Maybe after the compilation chapter/page.

John


More information about the dev mailing list