[dpdk-dev] [PATCH v2 0/3] split programmers guide a bit

Mcnamara, John john.mcnamara at intel.com
Tue Mar 31 13:34:02 CEST 2015


> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Thomas Monjalon
> Sent: Tuesday, March 31, 2015 12:38 AM
> To: Butler, Siobhan A
> Cc: dev at dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit
> 
> 2015-03-19 17:48, Thomas Monjalon:
> > Too many things are included in the programmers guide.
> > I think it should cover only API and knowledge needed to make an
> application.
> > That's why I suggest to move Xen and NICs doc outside.
> > Then it will be easier to add doc for a new environment or a new NIC.
> > Note that drivers or device-related libs like KNI, vhost or bonding
> > stay in the programmer's guide because they are more high-level than
> NICs drivers.
> >
> > Changes in v2:
> > - create index for Xen guide
> > - rename figure links
> > - rebase with mlx4
> > - HTML copyright removal has been sent separately
> >
> > Thomas Monjalon (3):
> >   doc: fix file attributes
> >   doc: move Xen guide out of programmers guide
> >   doc: nics guide
> 
> Applied with figures list restored on Bernard's request.

Hi,

Any objection to an additional patch to move the figure captions below the figures in the docs?

The caption above the figure was the format used in the initial docs, and it looks okay in the HTML output, but in the PDF output it tends to get merged into the preceding paragraph and isn't always on the same page as the figure.

John






More information about the dev mailing list