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

From: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
To: siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org,
	bernard.iremonger-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org
Cc: dev-VfR2kkLFssw@public.gmane.org
Subject: [PATCH v2 0/3] split programmers guide a bit
Date: Thu, 19 Mar 2015 17:48:28 +0100	[thread overview]
Message-ID: <1426783711-2407-1-git-send-email-thomas.monjalon@6wind.com> (raw)
In-Reply-To: <1422747307-13792-1-git-send-email-thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>

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

 MAINTAINERS                                        |  17 +-
 doc/guides/index.rst                               |   2 +
 .../driver_vm_emul_dev.rst => nics/e1000em.rst}    |   0
 doc/guides/{prog_guide => nics}/img/console.png    | Bin
 .../{prog_guide => nics}/img/fast_pkt_proc.png     | Bin
 .../{prog_guide => nics}/img/forward_stats.png     | Bin
 .../{prog_guide => nics}/img/host_vm_comms.png     | Bin
 .../img/host_vm_comms_qemu.png                     | Bin
 .../{prog_guide => nics}/img/inter_vm_comms.png    | Bin
 .../{prog_guide => nics}/img/perf_benchmark.png    | Bin
 .../{prog_guide => nics}/img/single_port_nic.png   | Bin
 .../{prog_guide => nics}/img/vm_vm_comms.png       | Bin
 .../{prog_guide => nics}/img/vmxnet3_int.png       | Bin
 doc/guides/{prog_guide => nics}/img/vswitch_vm.png | Bin
 doc/guides/{ => nics}/index.rst                    |  28 ++--
 .../intel_vf.rst}                                  |   8 +-
 doc/guides/nics/ixgbe.rst                          | 184 +++++++++++++++++++++
 .../mlx4_poll_mode_drv.rst => nics/mlx4.rst}       |   0
 .../pcap_ring.rst}                                 |   0
 .../virtio.rst}                                    |   4 +-
 .../vmxnet3.rst}                                   |   0
 doc/guides/prog_guide/index.rst                    |  18 --
 doc/guides/prog_guide/poll_mode_drv.rst            | 152 -----------------
 .../img/dpdk_xen_pkt_switch.png                    | Bin
 doc/guides/{prog_guide => xen}/img/grant_refs.png  | Bin
 doc/guides/{prog_guide => xen}/img/grant_table.png | Bin
 doc/guides/{ => xen}/index.rst                     |  21 +--
 .../pkt_switch.rst}                                |   0
 28 files changed, 228 insertions(+), 206 deletions(-)
 rename doc/guides/{prog_guide/driver_vm_emul_dev.rst => nics/e1000em.rst} (100%)
 rename doc/guides/{prog_guide => nics}/img/console.png (100%)
 rename doc/guides/{prog_guide => nics}/img/fast_pkt_proc.png (100%)
 rename doc/guides/{prog_guide => nics}/img/forward_stats.png (100%)
 rename doc/guides/{prog_guide => nics}/img/host_vm_comms.png (100%)
 rename doc/guides/{prog_guide => nics}/img/host_vm_comms_qemu.png (100%)
 rename doc/guides/{prog_guide => nics}/img/inter_vm_comms.png (100%)
 rename doc/guides/{prog_guide => nics}/img/perf_benchmark.png (100%)
 rename doc/guides/{prog_guide => nics}/img/single_port_nic.png (100%)
 rename doc/guides/{prog_guide => nics}/img/vm_vm_comms.png (100%)
 rename doc/guides/{prog_guide => nics}/img/vmxnet3_int.png (100%)
 rename doc/guides/{prog_guide => nics}/img/vswitch_vm.png (100%)
 copy doc/guides/{ => nics}/index.rst (88%)
 rename doc/guides/{prog_guide/i40e_ixgbe_igb_virt_func_drv.rst => nics/intel_vf.rst} (99%)
 mode change 100755 => 100644
 create mode 100644 doc/guides/nics/ixgbe.rst
 rename doc/guides/{prog_guide/mlx4_poll_mode_drv.rst => nics/mlx4.rst} (100%)
 rename doc/guides/{prog_guide/libpcap_ring_based_poll_mode_drv.rst => nics/pcap_ring.rst} (100%)
 rename doc/guides/{prog_guide/poll_mode_drv_emulated_virtio_nic.rst => nics/virtio.rst} (99%)
 rename doc/guides/{prog_guide/poll_mode_drv_paravirtual_vmxnets_nic.rst => nics/vmxnet3.rst} (100%)
 mode change 100755 => 100644 doc/guides/prog_guide/poll_mode_drv.rst
 rename doc/guides/{prog_guide => xen}/img/dpdk_xen_pkt_switch.png (100%)
 rename doc/guides/{prog_guide => xen}/img/grant_refs.png (100%)
 rename doc/guides/{prog_guide => xen}/img/grant_table.png (100%)
 copy doc/guides/{ => xen}/index.rst (88%)
 rename doc/guides/{prog_guide/intel_dpdk_xen_based_packet_switch_sol.rst => xen/pkt_switch.rst} (100%)

-- 
2.2.2