doc: programmers guide
authorBernard Iremonger <bernard.iremonger@intel.com>
Fri, 14 Nov 2014 11:53:41 +0000 (11:53 +0000)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Tue, 18 Nov 2014 13:49:54 +0000 (14:49 +0100)
commitfc1f2750a3ec6da919e3c86e59d56f34ec97154b
tree90bfbaeb8d079ad36aea970eaf2003247aeeec22
parenta4675d45cce945510f11a8a03a6cfe9ee871e67d
doc: programmers guide

The 1.7 DPDK_Prog_Guide document in MSWord has been converted to rst format for
use with Sphinx. There is an rst file for each chapter and an index.rst file
which contains the table of contents.
The top level index file has been modified to include this guide.

This document contains some png image files. If any of these png files are modified
they should be replaced with an svg file.

This is the sixth document from a set of 6 documents.

Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
113 files changed:
doc/guides/index.rst
doc/guides/prog_guide/build_app.rst [new file with mode: 0644]
doc/guides/prog_guide/dev_kit_build_system.rst [new file with mode: 0644]
doc/guides/prog_guide/dev_kit_root_make_help.rst [new file with mode: 0644]
doc/guides/prog_guide/driver_vm_emul_dev.rst [new file with mode: 0644]
doc/guides/prog_guide/env_abstraction_layer.rst [new file with mode: 0644]
doc/guides/prog_guide/ext_app_lib_make_help.rst [new file with mode: 0644]
doc/guides/prog_guide/extend_intel_dpdk.rst [new file with mode: 0644]
doc/guides/prog_guide/glossary.rst [new file with mode: 0644]
doc/guides/prog_guide/hash_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/i40e_ixgbe_igb_virt_func_drv.rst [new file with mode: 0644]
doc/guides/prog_guide/img/architecture-overview.svg [new file with mode: 0644]
doc/guides/prog_guide/img/blk_diag_dropper.png [new file with mode: 0644]
doc/guides/prog_guide/img/console.png [new file with mode: 0644]
doc/guides/prog_guide/img/data_struct_per_port.png [new file with mode: 0644]
doc/guides/prog_guide/img/dpdk_xen_pkt_switch.png [new file with mode: 0644]
doc/guides/prog_guide/img/drop_probability_eq3.png [new file with mode: 0644]
doc/guides/prog_guide/img/drop_probability_eq4.png [new file with mode: 0644]
doc/guides/prog_guide/img/drop_probability_graph.png [new file with mode: 0644]
doc/guides/prog_guide/img/eq2_expression.png [new file with mode: 0644]
doc/guides/prog_guide/img/eq2_factor.png [new file with mode: 0644]
doc/guides/prog_guide/img/ewma_filter_eq_1.png [new file with mode: 0644]
doc/guides/prog_guide/img/ewma_filter_eq_2.png [new file with mode: 0644]
doc/guides/prog_guide/img/ex_data_flow_tru_dropper.png [new file with mode: 0644]
doc/guides/prog_guide/img/fast_pkt_proc.png [new file with mode: 0644]
doc/guides/prog_guide/img/figure32.png [new file with mode: 0644]
doc/guides/prog_guide/img/figure33.png [new file with mode: 0644]
doc/guides/prog_guide/img/figure34.png [new file with mode: 0644]
doc/guides/prog_guide/img/figure35.png [new file with mode: 0644]
doc/guides/prog_guide/img/figure37.png [new file with mode: 0644]
doc/guides/prog_guide/img/figure38.png [new file with mode: 0644]
doc/guides/prog_guide/img/figure39.png [new file with mode: 0644]
doc/guides/prog_guide/img/flow_tru_droppper.png [new file with mode: 0644]
doc/guides/prog_guide/img/forward_stats.png [new file with mode: 0644]
doc/guides/prog_guide/img/grant_refs.png [new file with mode: 0644]
doc/guides/prog_guide/img/grant_table.png [new file with mode: 0644]
doc/guides/prog_guide/img/hier_sched_blk.png [new file with mode: 0644]
doc/guides/prog_guide/img/host_vm_comms.png [new file with mode: 0644]
doc/guides/prog_guide/img/host_vm_comms_qemu.png [new file with mode: 0644]
doc/guides/prog_guide/img/inter_vm_comms.png [new file with mode: 0644]
doc/guides/prog_guide/img/ivshmem.png [new file with mode: 0644]
doc/guides/prog_guide/img/kernel_nic_intf.png [new file with mode: 0644]
doc/guides/prog_guide/img/kni_traffic_flow.png [new file with mode: 0644]
doc/guides/prog_guide/img/link_bonding.png [new file with mode: 0644]
doc/guides/prog_guide/img/linuxapp_launch.svg [new file with mode: 0644]
doc/guides/prog_guide/img/m_definition.png [new file with mode: 0644]
doc/guides/prog_guide/img/malloc_heap.png [new file with mode: 0644]
doc/guides/prog_guide/img/mbuf1.svg [new file with mode: 0644]
doc/guides/prog_guide/img/mbuf2.svg [new file with mode: 0644]
doc/guides/prog_guide/img/memory-management.svg [new file with mode: 0644]
doc/guides/prog_guide/img/memory-management2.svg [new file with mode: 0644]
doc/guides/prog_guide/img/mempool.svg [new file with mode: 0644]
doc/guides/prog_guide/img/multi_process_memory.svg [new file with mode: 0644]
doc/guides/prog_guide/img/packet_distributor1.png [new file with mode: 0644]
doc/guides/prog_guide/img/packet_distributor2.png [new file with mode: 0644]
doc/guides/prog_guide/img/perf_benchmark.png [new file with mode: 0644]
doc/guides/prog_guide/img/pipe_prefetch_sm.png [new file with mode: 0644]
doc/guides/prog_guide/img/pkt_drop_probability.png [new file with mode: 0644]
doc/guides/prog_guide/img/pkt_flow_kni.png [new file with mode: 0644]
doc/guides/prog_guide/img/pkt_proc_pipeline_qos.png [new file with mode: 0644]
doc/guides/prog_guide/img/prefetch_pipeline.png [new file with mode: 0644]
doc/guides/prog_guide/img/ring-dequeue1.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-dequeue2.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-dequeue3.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-enqueue1.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-enqueue2.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-enqueue3.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-modulo1.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-modulo2.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-mp-enqueue1.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-mp-enqueue2.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-mp-enqueue3.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-mp-enqueue4.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring-mp-enqueue5.svg [new file with mode: 0644]
doc/guides/prog_guide/img/ring1.svg [new file with mode: 0644]
doc/guides/prog_guide/img/sched_hier_per_port.png [new file with mode: 0644]
doc/guides/prog_guide/img/single_port_nic.png [new file with mode: 0644]
doc/guides/prog_guide/img/tbl24_tbl8.png [new file with mode: 0644]
doc/guides/prog_guide/img/tbl24_tbl8_tbl8.png [new file with mode: 0644]
doc/guides/prog_guide/img/vhost_net_arch.png [new file with mode: 0644]
doc/guides/prog_guide/img/vm_vm_comms.png [new file with mode: 0644]
doc/guides/prog_guide/img/vmxnet3_int.png [new file with mode: 0644]
doc/guides/prog_guide/img/vswitch_vm.png [new file with mode: 0644]
doc/guides/prog_guide/index.rst [new file with mode: 0644]
doc/guides/prog_guide/intel_dpdk_xen_based_packet_switch_sol.rst [new file with mode: 0644]
doc/guides/prog_guide/intro.rst [new file with mode: 0644]
doc/guides/prog_guide/ip_fragment_reassembly_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/ivshmem_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/kernel_nic_interface.rst [new file with mode: 0644]
doc/guides/prog_guide/libpcap_ring_based_poll_mode_drv.rst [new file with mode: 0644]
doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/lpm6_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/lpm_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/malloc_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/mbuf_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/mempool_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/multi_proc_support.rst [new file with mode: 0644]
doc/guides/prog_guide/overview.rst [new file with mode: 0644]
doc/guides/prog_guide/packet_classif_access_ctrl.rst [new file with mode: 0644]
doc/guides/prog_guide/packet_distrib_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/packet_framework.rst [new file with mode: 0644]
doc/guides/prog_guide/perf_opt_guidelines.rst [new file with mode: 0644]
doc/guides/prog_guide/poll_mode_drv.rst [new file with mode: 0644]
doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst [new file with mode: 0644]
doc/guides/prog_guide/poll_mode_drv_paravirtual_vmxnets_nic.rst [new file with mode: 0644]
doc/guides/prog_guide/power_man.rst [new file with mode: 0644]
doc/guides/prog_guide/profile_app.rst [new file with mode: 0644]
doc/guides/prog_guide/qos_framework.rst [new file with mode: 0644]
doc/guides/prog_guide/ring_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/source_org.rst [new file with mode: 0644]
doc/guides/prog_guide/thread_safety_intel_dpdk_functions.rst [new file with mode: 0644]
doc/guides/prog_guide/timer_lib.rst [new file with mode: 0644]
doc/guides/prog_guide/writing_efficient_code.rst [new file with mode: 0644]