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.
I suggest also to remove the HTML footer to be more vendor neutral and
clearly welcome new contributors.
Thomas Monjalon (4):
doc: fix file attributes
doc: move Xen guide out of programmers guide
doc: nics guide
doc: remove copyright footer
MAINTAINERS | 15 +-
doc/guides/conf.py | 3 +-
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 | 27 +--
.../intel_vf.rst} | 0
doc/guides/nics/ixgbe.rst | 184 +++++++++++++++++++++
.../pcap_ring.rst} | 0
.../virtio.rst} | 0
.../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
.../index.rst} | 2 +
27 files changed, 215 insertions(+), 188 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} (100%)
mode change 100755 => 100644
create mode 100644 doc/guides/nics/ixgbe.rst
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} (100%)
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%)
rename doc/guides/{prog_guide/intel_dpdk_xen_based_packet_switch_sol.rst =>
xen/index.rst} (99%)
--
2.2.2
