Docs: Improve OVS DPDK version mapping notice.

A common issue is users pairing the incorrect version of OVS to DPDK when working outside of the build tree. To avoid this, this commit updates the OVS DPDK documentation to explicitly flag that users should consult the OVS to DPDK release mapping in FAQ if working outside of the OVS build tree. Suggested-by: Ben Pfaff <[email protected]> Signed-off-by: Ian Stokes <[email protected]> Acked-by: Flavio Leitner <[email protected]>
lhh · Jul 24, 2018 · 75119da · 75119da
1 parent 60d8cca
commit 75119da
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst
@@ -29,8 +29,10 @@ This document describes how to use Open vSwitch with DPDK datapath.
 
 .. important::
 
-   Using the DPDK datapath requires building OVS with DPDK support. Refer to
-   :doc:`/intro/install/dpdk` for more information.
+   Using the DPDK datapath requires building OVS with DPDK support. The
+   mapping of OVS version to DPDK can vary between releases. For version
+   mapping information refer to :doc:`releases FAQ </faq/releases>`. For
+   build instructions refer to :doc:`/intro/install/dpdk`.
 
 Ports and Bridges
 -----------------

diff --git a/Documentation/intro/install/dpdk.rst b/Documentation/intro/install/dpdk.rst
@@ -29,10 +29,12 @@ This document describes how to build and install Open vSwitch using a DPDK
 datapath. Open vSwitch can use the DPDK library to operate entirely in
 userspace.
 
-.. seealso::
+.. important::
 
     The :doc:`releases FAQ </faq/releases>` lists support for the required
-    versions of DPDK for each version of Open vSwitch.
+    versions of DPDK for each version of Open vSwitch. If building OVS and
+    DPDK outside of the master build tree users should consult this list
+    first.
 
 Build requirements
 ------------------