[ovs-dev] [PATCH v3 4/9] doc: Add "vdev" topic document
stephen at that.guru
Thu Apr 19 12:57:24 UTC 2018
These are separate things from physical, ring and vhost-user interfaces
and deserve their own documents. A couple of small typos are fixed along
Signed-off-by: Stephen Finucane <stephen at that.guru>
- Add new files to automake.mk
- Add 'versionchanged' directive to call out when this was added
Documentation/automake.mk | 1 +
Documentation/howto/dpdk.rst | 29 ------------------
Documentation/topics/dpdk/index.rst | 1 +
Documentation/topics/dpdk/vdev.rst | 61 +++++++++++++++++++++++++++++++++++++
4 files changed, 63 insertions(+), 29 deletions(-)
create mode 100644 Documentation/topics/dpdk/vdev.rst
diff --git a/Documentation/automake.mk b/Documentation/automake.mk
index 878de4349..3056e527a 100644
@@ -37,6 +37,7 @@ DOC_SOURCE = \
+ Documentation/topics/dpdk/vdev.rst \
diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst
index 531612880..9cb76b7e1 100644
@@ -244,35 +244,6 @@ Note about "Extended Statistics": vHost ports supports only partial
statistics. RX packet size based counter are only supported and
doesn't include TX packet size counters.
-DPDK provides drivers for both physical and virtual devices. Physical DPDK
-devices are added to OVS by specifying a valid PCI address in 'dpdk-devargs'.
-Virtual DPDK devices which do not have PCI addresses can be added using a
-different format for 'dpdk-devargs'.
-Typically, the format expected is 'eth_<driver_name><x>' where 'x' is a
-unique identifier of your choice for the given port.
-For example to add a dpdk port that uses the 'null' DPDK PMD driver::
- $ ovs-vsctl add-port br0 null0 -- set Interface null0 type=dpdk \
-Similarly, to add a dpdk port that uses the 'af_packet' DPDK PMD driver::
- $ ovs-vsctl add-port br0 myeth0 -- set Interface myeth0 type=dpdk \
-More information on the different types of virtual DPDK PMDs can be found in
-the `DPDK documentation
-Note: Not all DPDK virtual PMD drivers have been tested and verified to work.
EMC Insertion Probability
By default 1 in every 100 flows are inserted into the Exact Match Cache (EMC).
diff --git a/Documentation/topics/dpdk/index.rst b/Documentation/topics/dpdk/index.rst
index 4b4dc119a..c1e6ea78c 100644
@@ -34,4 +34,5 @@ The DPDK Datapath
diff --git a/Documentation/topics/dpdk/vdev.rst b/Documentation/topics/dpdk/vdev.rst
new file mode 100644
@@ -0,0 +1,61 @@
+ Copyright 2018, Red Hat, Inc.
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+ Convention for heading levels in Open vSwitch documentation:
+ ======= Heading 0 (reserved for the title in a document)
+ ------- Heading 1
+ ~~~~~~~ Heading 2
+ +++++++ Heading 3
+ ''''''' Heading 4
+ Avoid deeper levels because they do not render well.
+DPDK Virtual Devices
+DPDK provides drivers for both physical and virtual devices. Physical DPDK
+devices are added to OVS by specifying a valid PCI address in ``dpdk-devargs``.
+Virtual DPDK devices which do not have PCI addresses can be added using a
+different format for ``dpdk-devargs``.
+ Not all DPDK virtual PMD drivers have been tested and verified to work.
+.. versionadded:: 2.7.0
+To add a virtual ``dpdk`` devices, the ``dpdk-devargs`` argument should be of
+the format ``eth_<driver_name><x>``, where ``x``' is a unique identifier of
+your choice for the given port. For example to add a ``dpdk`` port that uses
+the ``null`` DPDK PMD driver, run::
+ $ ovs-vsctl add-port br0 null0 -- set Interface null0 type=dpdk \
+Similarly, to add a ``dpdk`` port that uses the ``af_packet`` DPDK PMD driver,
+ $ ovs-vsctl add-port br0 myeth0 -- set Interface myeth0 type=dpdk \
+More information on the different types of virtual DPDK PMDs can be found in
+the `DPDK documentation`__.
More information about the dev