DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [RFC PATCH 0/4] welcome doc for new nics and environments
@ 2015-01-31 23:35 Thomas Monjalon
  2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 1/4] doc: fix file attributes Thomas Monjalon
                   ` (5 more replies)
  0 siblings, 6 replies; 22+ messages in thread
From: Thomas Monjalon @ 2015-01-31 23:35 UTC (permalink / raw)
  To: dev

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

^ permalink raw reply	[flat|nested] 22+ messages in thread

end of thread, other threads:[~2015-04-02 11:04 UTC | newest]

Thread overview: 22+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-01-31 23:35 [dpdk-dev] [RFC PATCH 0/4] welcome doc for new nics and environments Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 1/4] doc: fix file attributes Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 2/4] doc: move Xen guide out of programmers guide Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 3/4] doc: nics guide Thomas Monjalon
2015-01-31 23:35 ` [dpdk-dev] [RFC PATCH 4/4] doc: remove copyright footer Thomas Monjalon
     [not found] ` <1678582.gq5SofjDC3@xps13>
     [not found]   ` <8CEF83825BEC744B83065625E567D7C2049DCD83@IRSMSX108.ger.corp.intel.com>
     [not found]     ` <1500004.RM7mZx5SlJ@xps13>
2015-02-02 17:54       ` [dpdk-dev] [RFC PATCH 3/4] doc: nics guide Iremonger, Bernard
2015-03-19 16:48 ` [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thomas Monjalon
2015-03-19 16:48   ` [dpdk-dev] [PATCH v2 1/3] doc: fix file attributes Thomas Monjalon
2015-03-19 18:03     ` Butler, Siobhan A
2015-03-19 16:48   ` [dpdk-dev] [PATCH v2 2/3] doc: move Xen guide out of programmers guide Thomas Monjalon
2015-03-19 18:03     ` Butler, Siobhan A
2015-03-19 16:48   ` [dpdk-dev] [PATCH v2 3/3] doc: nics guide Thomas Monjalon
2015-03-19 17:36     ` Iremonger, Bernard
2015-03-19 18:02     ` Butler, Siobhan A
2015-03-30 23:38   ` [dpdk-dev] [PATCH v2 0/3] split programmers guide a bit Thomas Monjalon
2015-03-31 11:34     ` Mcnamara, John
2015-03-31 12:23       ` Thomas Monjalon
2015-04-01  9:19         ` Iremonger, Bernard
2015-04-01 16:36           ` Mcnamara, John
2015-04-01 17:20             ` Iremonger, Bernard
2015-04-02  7:59               ` Mcnamara, John
2015-04-02 11:04       ` [dpdk-dev] [RFC] doc: refactored figure numbers into references John McNamara

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).