doc: refactor figure numbers into references
[dpdk.git] / doc / guides / sample_app_ug / index.rst
index ad2ca28..745a7ac 100644 (file)
@@ -1,5 +1,5 @@
 ..  BSD LICENSE
-    Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+    Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
     All rights reserved.
 
     Redistribution and use in source and binary forms, with or without
 Sample Applications User Guide
 ==============================
 
-June 2014
-
-INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS.
-NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT.
-EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS,
-INTEL ASSUMES NO LIABILITY WHATSOEVER AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY,
-RELATING TO SALE AND/OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT.
-
-A "Mission Critical Application" is any application in which failure of the Intel Product could result, directly or indirectly, in personal injury or death.
-SHOULD YOU PURCHASE OR USE INTEL'S PRODUCTS FOR ANY SUCH MISSION CRITICAL APPLICATION, YOU SHALL INDEMNIFY AND HOLD INTEL AND ITS SUBSIDIARIES,
-SUBCONTRACTORS AND AFFILIATES, AND THE DIRECTORS, OFFICERS, AND EMPLOYEES OF EACH, HARMLESS AGAINST ALL CLAIMS COSTS, DAMAGES,
-AND EXPENSES AND REASONABLE ATTORNEYS' FEES ARISING OUT OF, DIRECTLY OR INDIRECTLY, ANY CLAIM OF PRODUCT LIABILITY, PERSONAL INJURY,
-OR DEATH ARISING IN ANY WAY OUT OF SUCH MISSION CRITICAL APPLICATION,
-WHETHER OR NOT INTEL OR ITS SUBCONTRACTOR WAS NEGLIGENT IN THE DESIGN,
-MANUFACTURE, OR WARNING OF THE INTEL PRODUCT OR ANY OF ITS PARTS.
-
-Intel may make changes to specifications and product descriptions at any time, without notice.
-Designers must not rely on the absence or characteristics of any features or instructions marked "reserved" or "undefined".
-Intel reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them.
-The information here is subject to change without notice.
-Do not finalize a design with this information.
-
-The products described in this document may contain design defects or errors known as errata which may cause the product to deviate from published specifications.
-Current characterized errata are available on request.
-
-Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order.
-
-Copies of documents which have an order number and are referenced in this document, or other Intel literature, may be obtained by calling 1-800-548-4725, or go to:
-`http://www.intel.com/design/literature.htm <http://www.intel.com/design/literature.htm>`_.
-
-Intel and the Intel logo are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries.
-
-\*Other names and brands may be claimed as the property of others.
-
-Copyright © 2012 - 2014, Intel Corporation. All rights reserved.
+|today|
 
 **Contents**
 
@@ -78,10 +43,13 @@ Copyright © 2012 - 2014, Intel Corporation. All rights reserved.
     cmd_line
     exception_path
     hello_world
+    skeleton
+    rxtx_callbacks
     ip_frag
     ipv4_multicast
     ip_reassembly
     kernel_nic_interface
+    l2_forward_job_stats
     l2_forward_real_virtual
     l3_forward
     l3_forward_power_man
@@ -95,57 +63,74 @@ Copyright © 2012 - 2014, Intel Corporation. All rights reserved.
     intel_quickassist
     quota_watermark
     timer
+    packet_ordering
     vmdq_dcb_forwarding
     vhost
     netmap_compatibility
     internet_proto_ip_pipeline
     test_pipeline
+    dist_app
+    vm_power_management
 
 **Figures**
 
-:ref:`Figure 1.Packet Flow <figure_1>`
+:numref:`figure_exception_path_example` :ref:`figure_exception_path_example`
+
+:numref:`figure_kernel_nic` :ref:`figure_kernel_nic`
+
+:numref:`figure_l2_fwd_benchmark_setup_jobstats` :ref:`figure_l2_fwd_benchmark_setup_jobstats`
+
+:numref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats` :ref:`figure_l2_fwd_virtenv_benchmark_setup_jobstats`
+
+:numref:`figure_l2_fwd_benchmark_setup` :ref:`figure_l2_fwd_benchmark_setup`
+
+:numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`
+
+:numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
+
+:numref:`figure_example_rules` :ref:`figure_example_rules`
 
-:ref:`Figure 2.Kernel NIC Application Packet Flow <figure_2>`
+:numref:`figure_load_bal_app_arch` :ref:`figure_load_bal_app_arch`
 
-:ref:`Figure 3.Performance Benchmark Setup (Basic Environment) <figure_3>`
+:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app`
 
-:ref:`Figure 4.Performance Benchmark Setup (Virtualized Environment) <figure_4>`
+:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app`
 
-:ref:`Figure 5.Load Balancer Application Architecture <figure_5>`
+:numref:`figure_master_slave_proc` :ref:`figure_master_slave_proc`
 
-:ref:`Figure 5.Example Rules File <figure_5_1>`
+:numref:`figure_slave_proc_recov` :ref:`figure_slave_proc_recov`
 
-:ref:`Figure 6.Example Data Flow in a Symmetric Multi-process Application <figure_6>`
+:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch`
 
-:ref:`Figure 7.Example Data Flow in a Client-Server Symmetric Multi-process Application <figure_7>`
+:numref:`figure_quickassist_block_diagram` :ref:`figure_quickassist_block_diagram`
 
-:ref:`Figure 8.Master-slave Process Workflow <figure_8>`
+:numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview`
 
-:ref:`Figure 9.Slave Process Recovery Process Flow <figure_9>`
+:numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup`
 
-:ref:`Figure 10.QoS Scheduler Application Architecture <figure_10>`
+:numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines`
 
-:ref:`Figure 11.Intel®QuickAssist Technology Application Block Diagram <figure_11>`
+:numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`
 
-:ref:`Figure 12.Pipeline Overview <figure_12>`
+:numref:`figure_qemu_virtio_net` :ref:`figure_qemu_virtio_net`
 
-:ref:`Figure 13.Ring-based Processing Pipeline Performance Setup <figure_13>`
+:numref:`figure_virtio_linux_vhost` :ref:`figure_virtio_linux_vhost`
 
-:ref:`Figure 14.Threads and Pipelines <figure_14>`
+:numref:`figure_vhost_net_arch` :ref:`figure_vhost_net_arch`
 
-:ref:`Figure 15.Packet Flow Through the VMDQ and DCB Sample Application <figure_15>`
+:numref:`figure_vhost_net_sample_app` :ref:`figure_vhost_net_sample_app`
 
-:ref:`Figure 16.QEMU Virtio-net (prior to vhost-net) <figure_16>`
+:numref:`figure_tx_dpdk_testpmd` :ref:`figure_tx_dpdk_testpmd`
 
-:ref:`Figure 17.Virtio with Linux* Kernel Vhost <figure_17>`
+:numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`
 
-:ref:`Figure 18.Vhost-net Architectural Overview <figure_18>`
+:numref:`figure_dist_perf` :ref:`figure_dist_perf`
 
-:ref:`Figure 19.Packet Flow Through the vhost-net Sample Application <figure_19>`
+:numref:`figure_dist_app` :ref:`figure_dist_app`
 
-:ref:`Figure 20.Packet Flow on TX in DPDK-testpmd <figure_20>`
+:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel`
 
-:ref:`Figure 21.Test Pipeline Application <figure_21>`
+:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq`
 
 **Tables**