diff mbox

[ovs-dev,v2] doc: Link to release FAQ from DPDK install guide

Message ID 20170410141507.13711-1-stephen@that.guru
State Accepted
Headers show

Commit Message

Stephen Finucane April 10, 2017, 2:15 p.m. UTC
I wanted to find the mappings of DPDK versions to OVS versions. This was
a little more difficult than expected. Resolve the issue by linking to
it from the DPDK install guide.

Signed-off-by: Stephen Finucane <stephen@that.guru>
---
v2:
- Add a link to the releases FAQ from the installation section of the
  index page
---
 Documentation/index.rst              | 3 ++-
 Documentation/intro/install/dpdk.rst | 5 +++++
 2 files changed, 7 insertions(+), 1 deletion(-)

Comments

Ben Pfaff April 13, 2017, 8:35 p.m. UTC | #1
On Mon, Apr 10, 2017 at 03:15:07PM +0100, Stephen Finucane wrote:
> I wanted to find the mappings of DPDK versions to OVS versions. This was
> a little more difficult than expected. Resolve the issue by linking to
> it from the DPDK install guide.
> 
> Signed-off-by: Stephen Finucane <stephen@that.guru>
> ---
> v2:
> - Add a link to the releases FAQ from the installation section of the
>   index page

Thanks!  I applied this to master.
diff mbox

Patch

diff --git a/Documentation/index.rst b/Documentation/index.rst
index d81e9ba..5210a56 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -58,7 +58,8 @@  vSwitch? Start here.
   :doc:`intro/install/netbsd` |
   :doc:`intro/install/windows` |
   :doc:`intro/install/xenserver` |
-  :doc:`intro/install/dpdk`
+  :doc:`intro/install/dpdk` |
+  :doc:`Installation FAQs <faq/releases>`
 
 - **Tutorials:** :doc:`tutorials/ovs-advanced` |
   :doc:`tutorials/ovn-sandbox`
diff --git a/Documentation/intro/install/dpdk.rst b/Documentation/intro/install/dpdk.rst
index b947bd5..f29ac05 100644
--- a/Documentation/intro/install/dpdk.rst
+++ b/Documentation/intro/install/dpdk.rst
@@ -29,6 +29,11 @@  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::
+
+    The :doc:`releases FAQ </faq/releases>` lists support for the required
+    versions of DPDK for each version of Open vSwitch.
+
 Build requirements
 ------------------