summaryrefslogtreecommitdiff
path: root/doc/guides/sample_app_ug/tep_termination.rst
diff options
context:
space:
mode:
authorYuanhan Liu <yuanhan.liu@linux.intel.com>2016-11-02 11:15:00 +0800
committerThomas Monjalon <thomas.monjalon@6wind.com>2016-11-07 15:58:51 +0100
commita971c509a523c7c9be113f468f208b9695234b59 (patch)
tree72b01719cbe505da315a3f79d47f576c1c474538 /doc/guides/sample_app_ug/tep_termination.rst
parent647e191b5475d7c8ab3f6355e3ad3128ef5ee241 (diff)
downloaddpdk-a971c509a523c7c9be113f468f208b9695234b59.zip
dpdk-a971c509a523c7c9be113f468f208b9695234b59.tar.gz
dpdk-a971c509a523c7c9be113f468f208b9695234b59.tar.xz
doc: update vhost sample guide
For vhost-switch sample, the old guide takes too many words on vhost-cuse, which is mainly due to vhost-cuse is invented before vhost-user. Now vhost-cuse is removed, meaning the best part of the doc is useless. Instead of amending one piece here and there, this patch simply removes the most part of the doc and replace it with a simple test guide. For tep_term sample, mainly for removing the part has "vhost-cuse". Signed-off-by: Yuanhan Liu <yuanhan.liu@linux.intel.com> Acked-by: John McNamara <john.mcnamara@intel.com>
Diffstat (limited to 'doc/guides/sample_app_ug/tep_termination.rst')
-rw-r--r--doc/guides/sample_app_ug/tep_termination.rst54
1 files changed, 5 insertions, 49 deletions
diff --git a/doc/guides/sample_app_ug/tep_termination.rst b/doc/guides/sample_app_ug/tep_termination.rst
index c3d1e97..88e08cf 100644
--- a/doc/guides/sample_app_ug/tep_termination.rst
+++ b/doc/guides/sample_app_ug/tep_termination.rst
@@ -99,7 +99,8 @@ The sample will support the followings:
* TSO offload support for tunneling packet.
-The following figure shows the framework of the TEP termination sample application based on vhost-cuse.
+The following figure shows the framework of the TEP termination sample
+application based on DPDK vhost lib.
.. _figure_tep_termination_arch:
@@ -118,11 +119,6 @@ The example in this section have been validated with the following distributions
* Fedora* 20
-Prerequisites
--------------
-
-Refer to :ref:`vhost_app_prerequisites`.
-
Compiling the Sample Code
-------------------------
#. Compile vhost lib:
@@ -133,14 +129,6 @@ Compiling the Sample Code
CONFIG_RTE_LIBRTE_VHOST=y
- vhost user is turned on by default in the configure file config/common_linuxapp.
- To enable vhost cuse, disable vhost user.
-
- .. code-block:: console
-
- CONFIG_RTE_LIBRTE_VHOST_USER=n
-
- After vhost is enabled and the implementation is selected, build the vhost library.
#. Go to the examples directory:
@@ -167,40 +155,9 @@ Compiling the Sample Code
cd ${RTE_SDK}/examples/tep_termination
make
-#. Go to the eventfd_link directory(vhost cuse required):
-
- .. code-block:: console
-
- cd ${RTE_SDK}/lib/librte_vhost/eventfd_link
-
-#. Build the eventfd_link kernel module(vhost cuse required):
-
- .. code-block:: console
-
- make
-
Running the Sample Code
-----------------------
-#. Install the cuse kernel module(vhost cuse required):
-
- .. code-block:: console
-
- modprobe cuse
-
-#. Go to the eventfd_link directory(vhost cuse required):
-
- .. code-block:: console
-
- export RTE_SDK=/path/to/rte_sdk
- cd ${RTE_SDK}/lib/librte_vhost/eventfd_link
-
-#. Install the eventfd_link module(vhost cuse required):
-
- .. code-block:: console
-
- insmod ./eventfd_link.ko
-
#. Go to the examples directory:
.. code-block:: console
@@ -225,8 +182,7 @@ Parameters
**The same parameters with the vhost sample.**
-Refer to :ref:`vhost_app_parameters` for the meanings of 'Basename',
-'Stats', 'RX Retry', 'RX Retry Number' and 'RX Retry Delay Time'.
+Refer to :ref:`vhost_app_parameters` for detailed explanation.
**Number of Devices.**
@@ -303,12 +259,12 @@ The default value is 1.
Running the Virtual Machine (QEMU)
----------------------------------
-Refer to :ref:`vhost_app_running`.
+Refer to :ref:`vhost_app_run_vm`.
Running DPDK in the Virtual Machine
-----------------------------------
-Refer to :ref:`vhost_app_running_dpdk`.
+Refer to :ref:`vhost_app_run_dpdk_inside_guest`.
Passing Traffic to the Virtual Machine Device
---------------------------------------------