[dpdk-dev] [PULL REQUEST] doc: programmers guide.
Bernard Iremonger
bernard.iremonger at intel.com
Mon Nov 17 10:41:04 CET 2014
These changes are a conversion of the Programmers Guide from an MSWord file to Sphinx rst files.
The following changes since commit 07db4a9750940bbf95299a89afd12d178556e064:
examples/distributor: new sample app (2014-11-16 22:54:56 +0100)
are available in the git repository at:
git://dpdk.org/next/dpdk-doc master
Bernard Iremonger (1):
doc: programmers guide
doc/guides/index.rst | 1 +
doc/guides/prog_guide/build_app.rst | 128 +
doc/guides/prog_guide/dev_kit_build_system.rst | 418 ++++
doc/guides/prog_guide/dev_kit_root_make_help.rst | 255 ++
doc/guides/prog_guide/driver_vm_emul_dev.rst | 178 ++
doc/guides/prog_guide/env_abstraction_layer.rst | 215 ++
doc/guides/prog_guide/ext_app_lib_make_help.rst | 125 +
doc/guides/prog_guide/extend_intel_dpdk.rst | 136 ++
doc/guides/prog_guide/glossary.rst | 199 ++
doc/guides/prog_guide/hash_lib.rst | 134 ++
.../prog_guide/i40e_ixgbe_igb_virt_func_drv.rst | 553 +++++
.../prog_guide/img/architecture-overview.svg | 1011 ++++++++
doc/guides/prog_guide/img/blk_diag_dropper.png | Bin 0 -> 55303 bytes
doc/guides/prog_guide/img/console.png | Bin 0 -> 40850 bytes
doc/guides/prog_guide/img/data_struct_per_port.png | Bin 0 -> 58769 bytes
doc/guides/prog_guide/img/dpdk_xen_pkt_switch.png | Bin 0 -> 163842 bytes
doc/guides/prog_guide/img/drop_probability_eq3.png | Bin 0 -> 3205 bytes
doc/guides/prog_guide/img/drop_probability_eq4.png | Bin 0 -> 2737 bytes
.../prog_guide/img/drop_probability_graph.png | Bin 0 -> 62349 bytes
doc/guides/prog_guide/img/eq2_expression.png | Bin 0 -> 1614 bytes
doc/guides/prog_guide/img/eq2_factor.png | Bin 0 -> 995 bytes
doc/guides/prog_guide/img/ewma_filter_eq_1.png | Bin 0 -> 840 bytes
doc/guides/prog_guide/img/ewma_filter_eq_2.png | Bin 0 -> 1462 bytes
.../prog_guide/img/ex_data_flow_tru_dropper.png | Bin 0 -> 32578 bytes
doc/guides/prog_guide/img/fast_pkt_proc.png | Bin 0 -> 355905 bytes
doc/guides/prog_guide/img/figure32.png | Bin 0 -> 11603 bytes
doc/guides/prog_guide/img/figure33.png | Bin 0 -> 65216 bytes
doc/guides/prog_guide/img/figure34.png | Bin 0 -> 11581 bytes
doc/guides/prog_guide/img/figure35.png | Bin 0 -> 75012 bytes
doc/guides/prog_guide/img/figure37.png | Bin 0 -> 6934 bytes
doc/guides/prog_guide/img/figure38.png | Bin 0 -> 7372 bytes
doc/guides/prog_guide/img/figure39.png | Bin 0 -> 55986 bytes
doc/guides/prog_guide/img/flow_tru_droppper.png | Bin 0 -> 30870 bytes
doc/guides/prog_guide/img/forward_stats.png | Bin 0 -> 8849 bytes
doc/guides/prog_guide/img/grant_refs.png | Bin 0 -> 6405 bytes
doc/guides/prog_guide/img/grant_table.png | Bin 0 -> 96762 bytes
doc/guides/prog_guide/img/hier_sched_blk.png | Bin 0 -> 36328 bytes
doc/guides/prog_guide/img/host_vm_comms.png | Bin 0 -> 16487 bytes
doc/guides/prog_guide/img/host_vm_comms_qemu.png | Bin 0 -> 15383 bytes
doc/guides/prog_guide/img/inter_vm_comms.png | Bin 0 -> 370244 bytes
doc/guides/prog_guide/img/ivshmem.png | Bin 0 -> 44920 bytes
doc/guides/prog_guide/img/kernel_nic_intf.png | Bin 0 -> 185839 bytes
doc/guides/prog_guide/img/kni_traffic_flow.png | Bin 0 -> 366308 bytes
doc/guides/prog_guide/img/link_bonding.png | Bin 0 -> 223318 bytes
doc/guides/prog_guide/img/linuxapp_launch.svg | 762 ++++++
doc/guides/prog_guide/img/m_definition.png | Bin 0 -> 1261 bytes
doc/guides/prog_guide/img/malloc_heap.png | Bin 0 -> 81329 bytes
doc/guides/prog_guide/img/mbuf1.svg | 584 +++++
doc/guides/prog_guide/img/mbuf2.svg | 1263 ++++++++++
doc/guides/prog_guide/img/memory-management.svg | 2164 +++++++++++++++++
doc/guides/prog_guide/img/memory-management2.svg | 2301 ++++++++++++++++++
doc/guides/prog_guide/img/mempool.svg | 2434 ++++++++++++++++++++
doc/guides/prog_guide/img/multi_process_memory.svg | 102 +
doc/guides/prog_guide/img/packet_distributor1.png | Bin 0 -> 99482 bytes
doc/guides/prog_guide/img/packet_distributor2.png | Bin 0 -> 102867 bytes
doc/guides/prog_guide/img/perf_benchmark.png | Bin 0 -> 392248 bytes
doc/guides/prog_guide/img/pipe_prefetch_sm.png | Bin 0 -> 71898 bytes
doc/guides/prog_guide/img/pkt_drop_probability.png | Bin 0 -> 46368 bytes
doc/guides/prog_guide/img/pkt_flow_kni.png | Bin 0 -> 51088 bytes
.../prog_guide/img/pkt_proc_pipeline_qos.png | Bin 0 -> 93198 bytes
doc/guides/prog_guide/img/prefetch_pipeline.png | Bin 0 -> 56358 bytes
doc/guides/prog_guide/img/ring-dequeue1.svg | 690 ++++++
doc/guides/prog_guide/img/ring-dequeue2.svg | 653 ++++++
doc/guides/prog_guide/img/ring-dequeue3.svg | 648 ++++++
doc/guides/prog_guide/img/ring-enqueue1.svg | 599 +++++
doc/guides/prog_guide/img/ring-enqueue2.svg | 643 ++++++
doc/guides/prog_guide/img/ring-enqueue3.svg | 638 +++++
doc/guides/prog_guide/img/ring-modulo1.svg | 806 +++++++
doc/guides/prog_guide/img/ring-modulo2.svg | 851 +++++++
doc/guides/prog_guide/img/ring-mp-enqueue1.svg | 738 ++++++
doc/guides/prog_guide/img/ring-mp-enqueue2.svg | 779 +++++++
doc/guides/prog_guide/img/ring-mp-enqueue3.svg | 816 +++++++
doc/guides/prog_guide/img/ring-mp-enqueue4.svg | 816 +++++++
doc/guides/prog_guide/img/ring-mp-enqueue5.svg | 724 ++++++
doc/guides/prog_guide/img/ring1.svg | 386 ++++
doc/guides/prog_guide/img/sched_hier_per_port.png | Bin 0 -> 58973 bytes
doc/guides/prog_guide/img/single_port_nic.png | Bin 0 -> 425314 bytes
doc/guides/prog_guide/img/tbl24_tbl8.png | Bin 0 -> 95193 bytes
doc/guides/prog_guide/img/tbl24_tbl8_tbl8.png | Bin 0 -> 114003 bytes
doc/guides/prog_guide/img/vhost_net_arch.png | Bin 0 -> 251431 bytes
doc/guides/prog_guide/img/vm_vm_comms.png | Bin 0 -> 172288 bytes
doc/guides/prog_guide/img/vmxnet3_int.png | Bin 0 -> 107542 bytes
doc/guides/prog_guide/img/vswitch_vm.png | Bin 0 -> 123082 bytes
doc/guides/prog_guide/index.rst | 271 +++
.../intel_dpdk_xen_based_packet_switch_sol.rst | 464 ++++
doc/guides/prog_guide/intro.rst | 83 +
.../prog_guide/ip_fragment_reassembly_lib.rst | 138 ++
doc/guides/prog_guide/ivshmem_lib.rst | 158 ++
doc/guides/prog_guide/kernel_nic_interface.rst | 290 +++
.../libpcap_ring_based_poll_mode_drv.rst | 271 +++
.../prog_guide/link_bonding_poll_mode_drv_lib.rst | 278 +++
doc/guides/prog_guide/lpm6_lib.rst | 235 ++
doc/guides/prog_guide/lpm_lib.rst | 223 ++
doc/guides/prog_guide/malloc_lib.rst | 236 ++
doc/guides/prog_guide/mbuf_lib.rst | 192 ++
doc/guides/prog_guide/mempool_lib.rst | 148 ++
doc/guides/prog_guide/multi_proc_support.rst | 203 ++
doc/guides/prog_guide/overview.rst | 207 ++
.../prog_guide/packet_classif_access_ctrl.rst | 435 ++++
doc/guides/prog_guide/packet_distrib_lib.rst | 116 +
doc/guides/prog_guide/packet_framework.rst | 1183 ++++++++++
doc/guides/prog_guide/perf_opt_guidelines.rst | 46 +
doc/guides/prog_guide/poll_mode_drv.rst | 441 ++++
.../poll_mode_drv_emulated_virtio_nic.rst | 212 ++
.../poll_mode_drv_paravirtual_vmxnets_nic.rst | 184 ++
doc/guides/prog_guide/power_man.rst | 121 +
doc/guides/prog_guide/profile_app.rst | 52 +
doc/guides/prog_guide/qos_framework.rst | 1765 ++++++++++++++
doc/guides/prog_guide/ring_lib.rst | 376 +++
doc/guides/prog_guide/source_org.rst | 138 ++
.../thread_safety_intel_dpdk_functions.rst | 102 +
doc/guides/prog_guide/timer_lib.rst | 104 +
doc/guides/prog_guide/writing_efficient_code.rst | 232 ++
113 files changed, 31654 insertions(+), 0 deletions(-)
create mode 100644 doc/guides/prog_guide/build_app.rst
create mode 100644 doc/guides/prog_guide/dev_kit_build_system.rst
create mode 100644 doc/guides/prog_guide/dev_kit_root_make_help.rst
create mode 100644 doc/guides/prog_guide/driver_vm_emul_dev.rst
create mode 100644 doc/guides/prog_guide/env_abstraction_layer.rst
create mode 100644 doc/guides/prog_guide/ext_app_lib_make_help.rst
create mode 100644 doc/guides/prog_guide/extend_intel_dpdk.rst
create mode 100644 doc/guides/prog_guide/glossary.rst
create mode 100644 doc/guides/prog_guide/hash_lib.rst
create mode 100644 doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst
create mode 100644 doc/guides/prog_guide/img/architecture-overview.svg
create mode 100644 doc/guides/prog_guide/img/blk_diag_dropper.png
create mode 100644 doc/guides/prog_guide/img/console.png
create mode 100644 doc/guides/prog_guide/img/data_struct_per_port.png
create mode 100644 doc/guides/prog_guide/img/dpdk_xen_pkt_switch.png
create mode 100644 doc/guides/prog_guide/img/drop_probability_eq3.png
create mode 100644 doc/guides/prog_guide/img/drop_probability_eq4.png
create mode 100644 doc/guides/prog_guide/img/drop_probability_graph.png
create mode 100644 doc/guides/prog_guide/img/eq2_expression.png
create mode 100644 doc/guides/prog_guide/img/eq2_factor.png
create mode 100644 doc/guides/prog_guide/img/ewma_filter_eq_1.png
create mode 100644 doc/guides/prog_guide/img/ewma_filter_eq_2.png
create mode 100644 doc/guides/prog_guide/img/ex_data_flow_tru_dropper.png
create mode 100644 doc/guides/prog_guide/img/fast_pkt_proc.png
create mode 100644 doc/guides/prog_guide/img/figure32.png
create mode 100644 doc/guides/prog_guide/img/figure33.png
create mode 100644 doc/guides/prog_guide/img/figure34.png
create mode 100644 doc/guides/prog_guide/img/figure35.png
create mode 100644 doc/guides/prog_guide/img/figure37.png
create mode 100644 doc/guides/prog_guide/img/figure38.png
create mode 100644 doc/guides/prog_guide/img/figure39.png
create mode 100644 doc/guides/prog_guide/img/flow_tru_droppper.png
create mode 100644 doc/guides/prog_guide/img/forward_stats.png
create mode 100644 doc/guides/prog_guide/img/grant_refs.png
create mode 100644 doc/guides/prog_guide/img/grant_table.png
create mode 100644 doc/guides/prog_guide/img/hier_sched_blk.png
create mode 100644 doc/guides/prog_guide/img/host_vm_comms.png
create mode 100644 doc/guides/prog_guide/img/host_vm_comms_qemu.png
create mode 100644 doc/guides/prog_guide/img/inter_vm_comms.png
create mode 100644 doc/guides/prog_guide/img/ivshmem.png
create mode 100644 doc/guides/prog_guide/img/kernel_nic_intf.png
create mode 100644 doc/guides/prog_guide/img/kni_traffic_flow.png
create mode 100644 doc/guides/prog_guide/img/link_bonding.png
create mode 100644 doc/guides/prog_guide/img/linuxapp_launch.svg
create mode 100644 doc/guides/prog_guide/img/m_definition.png
create mode 100644 doc/guides/prog_guide/img/malloc_heap.png
create mode 100644 doc/guides/prog_guide/img/mbuf1.svg
create mode 100644 doc/guides/prog_guide/img/mbuf2.svg
create mode 100644 doc/guides/prog_guide/img/memory-management.svg
create mode 100644 doc/guides/prog_guide/img/memory-management2.svg
create mode 100644 doc/guides/prog_guide/img/mempool.svg
create mode 100644 doc/guides/prog_guide/img/multi_process_memory.svg
create mode 100644 doc/guides/prog_guide/img/packet_distributor1.png
create mode 100644 doc/guides/prog_guide/img/packet_distributor2.png
create mode 100644 doc/guides/prog_guide/img/perf_benchmark.png
create mode 100644 doc/guides/prog_guide/img/pipe_prefetch_sm.png
create mode 100644 doc/guides/prog_guide/img/pkt_drop_probability.png
create mode 100644 doc/guides/prog_guide/img/pkt_flow_kni.png
create mode 100644 doc/guides/prog_guide/img/pkt_proc_pipeline_qos.png
create mode 100644 doc/guides/prog_guide/img/prefetch_pipeline.png
create mode 100644 doc/guides/prog_guide/img/ring-dequeue1.svg
create mode 100644 doc/guides/prog_guide/img/ring-dequeue2.svg
create mode 100644 doc/guides/prog_guide/img/ring-dequeue3.svg
create mode 100644 doc/guides/prog_guide/img/ring-enqueue1.svg
create mode 100644 doc/guides/prog_guide/img/ring-enqueue2.svg
create mode 100644 doc/guides/prog_guide/img/ring-enqueue3.svg
create mode 100644 doc/guides/prog_guide/img/ring-modulo1.svg
create mode 100644 doc/guides/prog_guide/img/ring-modulo2.svg
create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue1.svg
create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue2.svg
create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue3.svg
create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue4.svg
create mode 100644 doc/guides/prog_guide/img/ring-mp-enqueue5.svg
create mode 100644 doc/guides/prog_guide/img/ring1.svg
create mode 100644 doc/guides/prog_guide/img/sched_hier_per_port.png
create mode 100644 doc/guides/prog_guide/img/single_port_nic.png
create mode 100644 doc/guides/prog_guide/img/tbl24_tbl8.png
create mode 100644 doc/guides/prog_guide/img/tbl24_tbl8_tbl8.png
create mode 100644 doc/guides/prog_guide/img/vhost_net_arch.png
create mode 100644 doc/guides/prog_guide/img/vm_vm_comms.png
create mode 100644 doc/guides/prog_guide/img/vmxnet3_int.png
create mode 100644 doc/guides/prog_guide/img/vswitch_vm.png
create mode 100644 doc/guides/prog_guide/index.rst
create mode 100644 doc/guides/prog_guide/intel_dpdk_xen_based_packet_switch_sol.rst
create mode 100644 doc/guides/prog_guide/intro.rst
create mode 100644 doc/guides/prog_guide/ip_fragment_reassembly_lib.rst
create mode 100644 doc/guides/prog_guide/ivshmem_lib.rst
create mode 100644 doc/guides/prog_guide/kernel_nic_interface.rst
create mode 100644 doc/guides/prog_guide/libpcap_ring_based_poll_mode_drv.rst
create mode 100644 doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst
create mode 100644 doc/guides/prog_guide/lpm6_lib.rst
create mode 100644 doc/guides/prog_guide/lpm_lib.rst
create mode 100644 doc/guides/prog_guide/malloc_lib.rst
create mode 100644 doc/guides/prog_guide/mbuf_lib.rst
create mode 100644 doc/guides/prog_guide/mempool_lib.rst
create mode 100644 doc/guides/prog_guide/multi_proc_support.rst
create mode 100644 doc/guides/prog_guide/overview.rst
create mode 100644 doc/guides/prog_guide/packet_classif_access_ctrl.rst
create mode 100644 doc/guides/prog_guide/packet_distrib_lib.rst
create mode 100644 doc/guides/prog_guide/packet_framework.rst
create mode 100644 doc/guides/prog_guide/perf_opt_guidelines.rst
create mode 100644 doc/guides/prog_guide/poll_mode_drv.rst
create mode 100644 doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst
create mode 100644 doc/guides/prog_guide/poll_mode_drv_paravirtual_vmxnets_nic.rst
create mode 100644 doc/guides/prog_guide/power_man.rst
create mode 100644 doc/guides/prog_guide/profile_app.rst
create mode 100644 doc/guides/prog_guide/qos_framework.rst
create mode 100644 doc/guides/prog_guide/ring_lib.rst
create mode 100644 doc/guides/prog_guide/source_org.rst
create mode 100644 doc/guides/prog_guide/thread_safety_intel_dpdk_functions.rst
create mode 100644 doc/guides/prog_guide/timer_lib.rst
create mode 100644 doc/guides/prog_guide/writing_efficient_code.rst
More information about the dev
mailing list