doc: add flow distributor example guide
[dpdk.git] / doc / guides / sample_app_ug / index.rst
index 50dac0f..260f6a5 100644 (file)
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-Sample Applications User Guide
-==============================
-
-|today|
-
-**Contents**
+Sample Applications User Guides
+===============================
 
 .. toctree::
     :maxdepth: 2
 
 .. toctree::
     :maxdepth: 2
@@ -41,6 +37,7 @@ Sample Applications User Guide
 
     intro
     cmd_line
 
     intro
     cmd_line
+    ethtool
     exception_path
     hello_world
     skeleton
     exception_path
     hello_world
     skeleton
@@ -49,14 +46,18 @@ Sample Applications User Guide
     ipv4_multicast
     ip_reassembly
     kernel_nic_interface
     ipv4_multicast
     ip_reassembly
     kernel_nic_interface
+    keep_alive
+    l2_forward_crypto
     l2_forward_job_stats
     l2_forward_real_virtual
     l2_forward_job_stats
     l2_forward_real_virtual
+    l2_forward_cat
     l3_forward
     l3_forward_power_man
     l3_forward_access_ctrl
     l3_forward_virtual
     link_status_intr
     load_balancer
     l3_forward
     l3_forward_power_man
     l3_forward_access_ctrl
     l3_forward_virtual
     link_status_intr
     load_balancer
+    flow_distributor
     multi_process
     qos_metering
     qos_scheduler
     multi_process
     qos_metering
     qos_scheduler
@@ -67,12 +68,14 @@ Sample Applications User Guide
     vmdq_dcb_forwarding
     vhost
     netmap_compatibility
     vmdq_dcb_forwarding
     vhost
     netmap_compatibility
-    internet_proto_ip_pipeline
+    ip_pipeline
     test_pipeline
     dist_app
     vm_power_management
     tep_termination
     test_pipeline
     dist_app
     vm_power_management
     tep_termination
-    proc_info
+    ptpclient
+    performance_thread
+    ipsec_secgw
 
 **Figures**
 
 
 **Figures**
 
@@ -88,6 +91,8 @@ Sample Applications User Guide
 
 :numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`
 
 
 :numref:`figure_l2_fwd_virtenv_benchmark_setup` :ref:`figure_l2_fwd_virtenv_benchmark_setup`
 
+:numref:`figure_l2_fwd_encrypt_flow` :ref:`figure_l2_fwd_encrypt_flow`
+
 :numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
 
 :numref:`figure_example_rules` :ref:`figure_example_rules`
 :numref:`figure_ipv4_acl_rule` :ref:`figure_ipv4_acl_rule`
 
 :numref:`figure_example_rules` :ref:`figure_example_rules`
@@ -114,16 +119,6 @@ Sample Applications User Guide
 
 :numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`
 
 
 :numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example`
 
-:numref:`figure_qemu_virtio_net` :ref:`figure_qemu_virtio_net`
-
-:numref:`figure_virtio_linux_vhost` :ref:`figure_virtio_linux_vhost`
-
-:numref:`figure_vhost_net_arch` :ref:`figure_vhost_net_arch`
-
-:numref:`figure_vhost_net_sample_app` :ref:`figure_vhost_net_sample_app`
-
-:numref:`figure_tx_dpdk_testpmd` :ref:`figure_tx_dpdk_testpmd`
-
 :numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`
 
 :numref:`figure_dist_perf` :ref:`figure_dist_perf`
 :numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app`
 
 :numref:`figure_dist_perf` :ref:`figure_dist_perf`
@@ -136,6 +131,8 @@ Sample Applications User Guide
 :numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
 :numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`
 
 :numref:`figure_overlay_networking` :ref:`figure_overlay_networking`
 :numref:`figure_tep_termination_arch` :ref:`figure_tep_termination_arch`
 
+:numref:`figure_ptpclient_highlevel` :ref:`figure_ptpclient_highlevel`
+
 **Tables**
 
 :numref:`table_qos_metering_1` :ref:`table_qos_metering_1`
 **Tables**
 
 :numref:`table_qos_metering_1` :ref:`table_qos_metering_1`