diff options
Diffstat (limited to 'doc/guides/sample_app_ug')
| -rw-r--r-- | doc/guides/sample_app_ug/index.rst | 60 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/intro.rst | 10 | ||||
| -rw-r--r-- | doc/guides/sample_app_ug/vhost_crypto.rst | 2 |
3 files changed, 11 insertions, 61 deletions
diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst index b2455e09..2945be08 100644 --- a/doc/guides/sample_app_ug/index.rst +++ b/doc/guides/sample_app_ug/index.rst @@ -58,63 +58,3 @@ Sample Applications User Guides fips_validation ipsec_secgw bbdev_app - -**Figures** - -: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_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_load_bal_app_arch` :ref:`figure_load_bal_app_arch` - -:numref:`figure_sym_multi_proc_app` :ref:`figure_sym_multi_proc_app` - -:numref:`figure_client_svr_sym_multi_proc_app` :ref:`figure_client_svr_sym_multi_proc_app` - -:numref:`figure_qos_sched_app_arch` :ref:`figure_qos_sched_app_arch` - -:numref:`figure_pipeline_overview` :ref:`figure_pipeline_overview` - -:numref:`figure_ring_pipeline_perf_setup` :ref:`figure_ring_pipeline_perf_setup` - -:numref:`figure_threads_pipelines` :ref:`figure_threads_pipelines` - -:numref:`figure_vmdq_dcb_example` :ref:`figure_vmdq_dcb_example` - -:numref:`figure_test_pipeline_app` :ref:`figure_test_pipeline_app` - -:numref:`figure_dist_perf` :ref:`figure_dist_perf` - -:numref:`figure_dist_app` :ref:`figure_dist_app` - -:numref:`figure_vm_power_mgr_highlevel` :ref:`figure_vm_power_mgr_highlevel` - -:numref:`figure_vm_power_mgr_vm_request_seq` :ref:`figure_vm_power_mgr_vm_request_seq` -: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` - -:numref:`figure_efd_sample_app_overview` :ref:`figure_efd_sample_app_overview` - -**Tables** - -:numref:`table_qos_metering_1` :ref:`table_qos_metering_1` - -:numref:`table_qos_scheduler_1` :ref:`table_qos_scheduler_1` - -:numref:`table_test_pipeline_1` :ref:`table_test_pipeline_1` diff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst index 575995de..159bcf73 100644 --- a/doc/guides/sample_app_ug/intro.rst +++ b/doc/guides/sample_app_ug/intro.rst @@ -10,6 +10,16 @@ DPDK features. Users interested in getting started with DPDK can take the applications, try out the features, and then extend them to fit their needs. +Running Sample Applications +--------------------------- + +Some sample applications may have their own command-line parameters described in +their respective guides, however all of them also share the same EAL parameters. +Please refer to :doc:`../linux_gsg/linux_eal_parameters` or +:doc:`../freebsd_gsg/freebsd_eal_parameters` for a list of available EAL +command-line options. + + The DPDK Sample Applications ---------------------------- diff --git a/doc/guides/sample_app_ug/vhost_crypto.rst b/doc/guides/sample_app_ug/vhost_crypto.rst index 3db57eab..bbc25bde 100644 --- a/doc/guides/sample_app_ug/vhost_crypto.rst +++ b/doc/guides/sample_app_ug/vhost_crypto.rst @@ -30,7 +30,7 @@ Start the vhost_crypto example ./vhost_crypto [EAL options] -- --config (lcore,cdev-id,queue-id)[,(lcore,cdev-id,queue-id)] - --socketfile lcore,PATH + --socket-file lcore,PATH [--zero-copy] [--guest-polling] |