From patchwork Thu Jul 12 18:48:42 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Stokes, Ian" X-Patchwork-Id: 943164 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=openvswitch.org (client-ip=140.211.169.12; helo=mail.linuxfoundation.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=intel.com Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 41RQ2B3psdz9s0n for ; Fri, 13 Jul 2018 04:48:49 +1000 (AEST) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 03FCED1B; Thu, 12 Jul 2018 18:48:47 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 1A5E9BAC for ; Thu, 12 Jul 2018 18:48:46 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id B35FD76F for ; Thu, 12 Jul 2018 18:48:45 +0000 (UTC) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 12 Jul 2018 11:48:45 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,344,1526367600"; d="scan'208";a="57208311" Received: from sivswdev01.ir.intel.com (HELO localhost.localdomain) ([10.237.217.45]) by orsmga006.jf.intel.com with ESMTP; 12 Jul 2018 11:48:44 -0700 From: Ian Stokes To: dev@openvswitch.org Date: Thu, 12 Jul 2018 19:48:42 +0100 Message-Id: <1531421322-32627-1-git-send-email-ian.stokes@intel.com> X-Mailer: git-send-email 1.7.0.7 X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [PATCH] Docs: Improve OVS DPDK version mapping notice. X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: ovs-dev-bounces@openvswitch.org Errors-To: ovs-dev-bounces@openvswitch.org 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 Signed-off-by: Ian Stokes Acked-by: Flavio Leitner --- Documentation/howto/dpdk.rst | 6 ++++-- Documentation/intro/install/dpdk.rst | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst index 82596f5..ab3d576 100644 --- 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 `. 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 index 2468c64..407435a 100644 --- 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 ` 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 ------------------