summaryrefslogtreecommitdiff
path: root/Documentation/topics
diff options
context:
space:
mode:
authorBen Pfaff <blp@ovn.org>2019-10-23 10:19:39 -0700
committerBen Pfaff <blp@ovn.org>2019-10-23 12:38:19 -0700
commit49df3c0fe779d34d19b0e1b150cdaa926f2bb8e9 (patch)
treeb9b2883fb45503cd5c628b06343d6328c264585d /Documentation/topics
parent653eedff20fa30111c24b4ce338367155af9373e (diff)
downloadopenvswitch-49df3c0fe779d34d19b0e1b150cdaa926f2bb8e9.tar.gz
docs: DPDK isn't a datapath, so don't use the term.
The DPDK library allows OVS fast access to packet I/O in userspace. It is not a datapath. This commit avoids using that term. Suggested-by: Ilya Maximets <i.maximets@ovn.org> Acked-by: Ilya Maximets <i.maximets@ovn.org> Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/topics')
-rw-r--r--Documentation/topics/dpdk/bridge.rst7
-rw-r--r--Documentation/topics/dpdk/index.rst6
-rw-r--r--Documentation/topics/dpdk/phy.rst10
-rw-r--r--Documentation/topics/dpdk/pmd.rst6
-rw-r--r--Documentation/topics/dpdk/ring.rst6
-rw-r--r--Documentation/topics/dpdk/vhost-user.rst6
-rw-r--r--Documentation/topics/testing.rst4
7 files changed, 23 insertions, 22 deletions
diff --git a/Documentation/topics/dpdk/bridge.rst b/Documentation/topics/dpdk/bridge.rst
index 4ca79a4ab..d9bc7eba4 100644
--- a/Documentation/topics/dpdk/bridge.rst
+++ b/Documentation/topics/dpdk/bridge.rst
@@ -25,13 +25,14 @@
DPDK Bridges
============
-The DPDK datapath requires specially configured bridge(s) in order to utilize
-DPDK-backed :doc:`physical <phy>` and :doc:`virtual <vhost-user>` ports.
+Bridge must be specially configured to utilize DPDK-backed
+:doc:`physical <phy>` and :doc:`virtual <vhost-user>` ports.
Quick Example
-------------
-This example demonstrates how to add a bridge using the DPDK datapath::
+This example demonstrates how to add a bridge that will take advantage
+of DPDK::
$ ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev
diff --git a/Documentation/topics/dpdk/index.rst b/Documentation/topics/dpdk/index.rst
index cf24a7b6d..f2862ea70 100644
--- a/Documentation/topics/dpdk/index.rst
+++ b/Documentation/topics/dpdk/index.rst
@@ -21,9 +21,9 @@
Avoid deeper levels because they do not render well.
-=================
-The DPDK Datapath
-=================
+============
+DPDK Support
+============
.. NOTE(stephenfin): Part of this doc is included in 'howto/dpdk'. Update that
.. if you modify this document
diff --git a/Documentation/topics/dpdk/phy.rst b/Documentation/topics/dpdk/phy.rst
index 93d74df45..0867076da 100644
--- a/Documentation/topics/dpdk/phy.rst
+++ b/Documentation/topics/dpdk/phy.rst
@@ -125,11 +125,11 @@ Multiqueue
----------
Poll Mode Driver (PMD) threads are the threads that do the heavy lifting for
-the DPDK datapath. Correct configuration of PMD threads and the Rx queues they
-utilize is a requirement in order to deliver the high-performance possible with
-DPDK acceleration. It is possible to configure multiple Rx queues for ``dpdk``
-ports, thus ensuring this is not a bottleneck for performance. For information
-on configuring PMD threads, refer to :doc:`pmd`.
+userspace switching. Correct configuration of PMD threads and the Rx
+queues they utilize is a requirement in order to deliver the high-performance
+possible with DPDK acceleration. It is possible to configure multiple Rx queues
+for ``dpdk`` ports, thus ensuring this is not a bottleneck for performance. For
+information on configuring PMD threads, refer to :doc:`pmd`.
.. _dpdk-phy-flow-control:
diff --git a/Documentation/topics/dpdk/pmd.rst b/Documentation/topics/dpdk/pmd.rst
index b0e19d794..6f1fdcbc6 100644
--- a/Documentation/topics/dpdk/pmd.rst
+++ b/Documentation/topics/dpdk/pmd.rst
@@ -26,9 +26,9 @@ PMD Threads
===========
Poll Mode Driver (PMD) threads are the threads that do the heavy lifting for
-the DPDK datapath and perform tasks such as continuous polling of input ports
-for packets, classifying packets once received, and executing actions on the
-packets once they are classified.
+userspace switching. They perform tasks such as continuous polling of
+input ports for packets, classifying packets once received, and executing
+actions on the packets once they are classified.
PMD threads utilize Receive (Rx) and Transmit (Tx) queues, commonly known as
*rxq*\s and *txq*\s. While Tx queue configuration happens automatically, Rx
diff --git a/Documentation/topics/dpdk/ring.rst b/Documentation/topics/dpdk/ring.rst
index e48b44ce8..81c2efb37 100644
--- a/Documentation/topics/dpdk/ring.rst
+++ b/Documentation/topics/dpdk/ring.rst
@@ -32,9 +32,9 @@ DPDK Ring Ports
:doc:`vhost-user ports <vhost-user>` are a better choice and should be used
instead.
-The DPDK datapath provides DPDK-backed ring ports that are implemented using
-DPDK's ``librte_ring`` library. For more information on this library, refer to
-the `DPDK documentation`_.
+OVS userspace switching supports ring ports implemented using DPDK's
+``librte_ring`` library. For more information on this library, refer
+to the `DPDK documentation`_.
.. important::
diff --git a/Documentation/topics/dpdk/vhost-user.rst b/Documentation/topics/dpdk/vhost-user.rst
index fab87bd3d..cda5b122f 100644
--- a/Documentation/topics/dpdk/vhost-user.rst
+++ b/Documentation/topics/dpdk/vhost-user.rst
@@ -25,9 +25,9 @@
DPDK vHost User Ports
=====================
-The DPDK datapath provides DPDK-backed vHost user ports as a primary way to
-interact with guests. For more information on vHost User, refer to the `QEMU
-documentation`_ on same.
+OVS userspace switching supports supports vHost user ports as a
+primary way to interact with guests. For more information on vHost
+User, refer to the `QEMU documentation`_ on same.
.. important::
diff --git a/Documentation/topics/testing.rst b/Documentation/topics/testing.rst
index 31433c591..8b5d268e0 100644
--- a/Documentation/topics/testing.rst
+++ b/Documentation/topics/testing.rst
@@ -324,8 +324,8 @@ The results of the testsuite are in ``tests/system-userspace-testsuite.dir``.
All the features documented under `Unit Tests`_ are available for the userspace
datapath testsuite.
-DPDK datapath
-'''''''''''''
+Userspace datapath with DPDK
+''''''''''''''''''''''''''''
To test :doc:`/intro/install/dpdk` (i.e., the build was configured with
``--with-dpdk``, the DPDK is installed), run the testsuite and generate