doc: sample application user guide
authorBernard Iremonger <bernard.iremonger@intel.com>
Tue, 11 Nov 2014 12:27:01 +0000 (12:27 +0000)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Thu, 13 Nov 2014 00:36:44 +0000 (01:36 +0100)
commitd0dff9ba445e47199a420dd4b5451ec2860d3d3b
tree3608b30f5ef322ebfca8aeebddbed048d38f79c0
parent002ade70e93391ec43bd3653bfac01253343d111
doc: sample application user guide

The 1.7 DPDK_SampleApp_UG 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 thes png files are modified
they should be replaced with an svg file.

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

Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
51 files changed:
doc/guides/index.rst
doc/guides/sample_app_ug/cmd_line.rst [new file with mode: 0644]
doc/guides/sample_app_ug/exception_path.rst [new file with mode: 0644]
doc/guides/sample_app_ug/hello_world.rst [new file with mode: 0644]
doc/guides/sample_app_ug/img/client_svr_sym_multi_proc_app.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/example_rules.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/exception_path_example.svg [new file with mode: 0644]
doc/guides/sample_app_ug/img/ipv4_acl_rule.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/kernel_nic.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/l2_fwd_benchmark_setup.svg [new file with mode: 0644]
doc/guides/sample_app_ug/img/l2_fwd_virtenv_benchmark_setup.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/load_bal_app_arch.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/master_slave_proc.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/pipeline_overview.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/qemu_virtio_net.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/qos_sched_app_arch.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/quickassist_block_diagram.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/ring_pipeline_perf_setup.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/slave_proc_recov.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/sym_multi_proc_app.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/test_pipeline_app.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/threads_pipelines.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/tx_dpdk_testpmd.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/vhost_net_arch.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/vhost_net_sample_app.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/virtio_linux_vhost.png [new file with mode: 0644]
doc/guides/sample_app_ug/img/vmdq_dcb_example.svg [new file with mode: 0644]
doc/guides/sample_app_ug/index.rst [new file with mode: 0644]
doc/guides/sample_app_ug/intel_quickassist.rst [new file with mode: 0644]
doc/guides/sample_app_ug/internet_proto_ip_pipeline.rst [new file with mode: 0644]
doc/guides/sample_app_ug/intro.rst [new file with mode: 0644]
doc/guides/sample_app_ug/ip_frag.rst [new file with mode: 0644]
doc/guides/sample_app_ug/ip_reassembly.rst [new file with mode: 0644]
doc/guides/sample_app_ug/ipv4_multicast.rst [new file with mode: 0644]
doc/guides/sample_app_ug/kernel_nic_interface.rst [new file with mode: 0644]
doc/guides/sample_app_ug/l2_forward_real_virtual.rst [new file with mode: 0644]
doc/guides/sample_app_ug/l3_forward.rst [new file with mode: 0644]
doc/guides/sample_app_ug/l3_forward_access_ctrl.rst [new file with mode: 0644]
doc/guides/sample_app_ug/l3_forward_power_man.rst [new file with mode: 0644]
doc/guides/sample_app_ug/l3_forward_virtual.rst [new file with mode: 0644]
doc/guides/sample_app_ug/link_status_intr.rst [new file with mode: 0644]
doc/guides/sample_app_ug/load_balancer.rst [new file with mode: 0644]
doc/guides/sample_app_ug/multi_process.rst [new file with mode: 0644]
doc/guides/sample_app_ug/netmap_compatibility.rst [new file with mode: 0644]
doc/guides/sample_app_ug/qos_metering.rst [new file with mode: 0644]
doc/guides/sample_app_ug/qos_scheduler.rst [new file with mode: 0644]
doc/guides/sample_app_ug/quota_watermark.rst [new file with mode: 0644]
doc/guides/sample_app_ug/test_pipeline.rst [new file with mode: 0644]
doc/guides/sample_app_ug/timer.rst [new file with mode: 0644]
doc/guides/sample_app_ug/vhost.rst [new file with mode: 0644]
doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst [new file with mode: 0644]