[dpdk-dev] [RFC PATCH 3/4] doc: nics guide

Thomas Monjalon thomas.monjalon at 6wind.com
Mon Feb 2 15:33:30 CET 2015


Hi Bernard,

Please try to remove useless lines when answering.
I'm digging in the message to find your comments ;)

2015-02-02 14:11, Iremonger, Bernard:
> From: Thomas Monjalon [mailto:thomas.monjalon at 6wind.com]
> > --- /dev/null
> > +++ b/doc/guides/nics/ixgbe.rst
> > @@ -0,0 +1,184 @@
> > +..  BSD LICENSE
> > +    Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
> Hi Thomas,
> 
> 2014  should move to 2015

I think I should keep it as is because I'm only moving sections
and I don't have any right to change an Intel copyright.

> > --- a/doc/guides/prog_guide/index.rst
> > +++ b/doc/guides/prog_guide/index.rst
> > @@ -48,12 +48,7 @@ Programmer's Guide
> >      mempool_lib
> >      mbuf_lib
> >      poll_mode_drv
> > -    i40e_ixgbe_igb_virt_func_drv
> > -    driver_vm_emul_dev
> >      ivshmem_lib
> > -    poll_mode_drv_emulated_virtio_nic
> > -    poll_mode_drv_paravirtual_vmxnets_nic
> > -    libpcap_ring_based_poll_mode_drv
> >      link_bonding_poll_mode_drv_lib
> >      timer_lib
> >      hash_lib
> > @@ -101,18 +96,6 @@ Programmer's Guide
> > 
> >  :ref:`Figure 9. An mbuf with Three Segments <pg_figure_9>`
> > 
> > -:ref:`Figure 10. Virtualization for a Single Port NIC in SR-IOV Mode <pg_figure_10>`
> > -
> > -:ref:`Figure 11. Performance Benchmark Setup <pg_figure_11>`
> > -
> > -:ref:`Figure 12. Fast Host-based Packet Processing <pg_figure_12>`
> > -
> > -:ref:`Figure 13. Inter-VM Communication <pg_figure_13>`
> > -
> > -:ref:`Figure 14. Host2VM Communication Example Using kni vhost Back End <pg_figure_14>`
> > -
> > -:ref:`Figure 15. Host2VM Communication Example Using qemu vhost Back End <pg_figure_15>`
> > -
> >  :ref:`Figure 16. Memory Sharing inthe Intel® DPDK Multi-process Sample Application <pg_figure_16>`
> > 
> >  :ref:`Figure 17. Components of an Intel® DPDK KNI Application <pg_figure_17>` diff --git
> 
> References to Figures 9 to 17 have been removed have they been reinstated somewhere else ?

Figures 10 to 15 moved in doc/guides/nics/img.

I didn't re-create the references in doc/guides/nics/index.rst nor renumbered
the ones in doc/guides/prog_guide/index.rst.
I think these manual numberings should be removed as it is a pain to update.
Actually I don't really understand what is the usage of such references.
So I suggest to completely remove them or generate them with a script.

Thanks
-- 
Thomas


More information about the dev mailing list