From patchwork Thu Mar 11 20:38:19 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ilya Maximets X-Patchwork-Id: 1451525 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=2605:bc80:3010::133; helo=smtp2.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Received: from smtp2.osuosl.org (smtp2.osuosl.org [IPv6:2605:bc80:3010::133]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4DxLPj3cYcz9sS8 for ; Fri, 12 Mar 2021 07:38:33 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by smtp2.osuosl.org (Postfix) with ESMTP id 127D4431F7; Thu, 11 Mar 2021 20:38:31 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp2.osuosl.org ([127.0.0.1]) by localhost (smtp2.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id yN9mJU0cHg5r; Thu, 11 Mar 2021 20:38:30 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by smtp2.osuosl.org (Postfix) with ESMTP id 3289142049; Thu, 11 Mar 2021 20:38:29 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 0501BC000A; Thu, 11 Mar 2021 20:38:29 +0000 (UTC) X-Original-To: ovs-dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from smtp4.osuosl.org (smtp4.osuosl.org [IPv6:2605:bc80:3010::137]) by lists.linuxfoundation.org (Postfix) with ESMTP id BA427C0001 for ; Thu, 11 Mar 2021 20:38:27 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp4.osuosl.org (Postfix) with ESMTP id 93B894ECAC for ; Thu, 11 Mar 2021 20:38:27 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from smtp4.osuosl.org ([127.0.0.1]) by localhost (smtp4.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id lG83aJ1bnb2H for ; Thu, 11 Mar 2021 20:38:26 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.8.0 Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by smtp4.osuosl.org (Postfix) with ESMTPS id 0DFB045F30 for ; Thu, 11 Mar 2021 20:38:25 +0000 (UTC) X-Originating-IP: 78.45.89.65 Received: from im-t490s.redhat.com (ip-78-45-89-65.net.upcbroadband.cz [78.45.89.65]) (Authenticated sender: i.maximets@ovn.org) by relay6-d.mail.gandi.net (Postfix) with ESMTPSA id DE89DC0006; Thu, 11 Mar 2021 20:38:21 +0000 (UTC) From: Ilya Maximets To: ovs-dev@openvswitch.org, Ben Pfaff Date: Thu, 11 Mar 2021 21:38:19 +0100 Message-Id: <20210311203819.2526788-1-i.maximets@ovn.org> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Cc: Ilya Maximets , Dumitru Ceara Subject: [ovs-dev] [PATCH ovn] docs: Clarify that OVS submodule should not be used to build OVS itself. X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ovs-dev-bounces@openvswitch.org Sender: "dev" It's unclear from the documentation that users should not use OVS from the submodule to build actual OVS binaries (ovs-vswitchd or ovsdb-server). Released and supported versions of Open vSwitch should be used for that purpose. Signed-off-by: Ilya Maximets Acked-by: Ben Pfaff --- Documentation/intro/install/general.rst | 29 ++++++++++++++++--------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst index bbd303227..08a03a632 100644 --- a/Documentation/intro/install/general.rst +++ b/Documentation/intro/install/general.rst @@ -67,9 +67,18 @@ need the following software: - Open vSwitch (https://docs.openvswitch.org/en/latest/intro/install/). Open vSwitch is included as a submodule in the OVN source code. It is - kept at the minimum recommended version for OVN to operate optimally. - See below for instructions about how to use a different OVS source - location. + kept at the minimum recommended version for OVN to build and operate + optimally. See below for instructions about how to use a different OVS + source location. + + .. note:: + + These OVS sources used as a set of libraries to build OVN binaries, so + OVS submodule is only recommended to build OVN and *not recommended* + to be used as a source for OVS build. To actually build/run OVS binaries + (``ovs-vswitchd``, ``ovsdb-server``) use `released versions of + Open vSwitch `_ or packages + provided in your distribution. - GNU make @@ -157,8 +166,8 @@ the "configure" script:: $ ./boot.sh -Before configuring OVN, build Open vSwitch. The easiest way to do this -is to use the included OVS submodule in the OVN source:: +Before configuring OVN, prepare Open vSwitch sources. The easiest way to do +this is to use the included OVS submodule in the OVN source tree:: $ git submodule update --init $ cd ovs @@ -167,11 +176,11 @@ is to use the included OVS submodule in the OVN source:: $ make $ cd .. -It is not required to use the included OVS submodule; however the OVS -submodule is guaranteed to be the minimum recommended version of OVS -to ensure OVN's optimal operation. If you wish to use OVS source code -from a different location on the file system, then be sure to configure -and build OVS before building OVN. +It is not required to build with the included OVS submodule; however the OVS +submodule is guaranteed to include minimum recommended version of OVS libraries +to ensure OVN's build and optimal operation. If you wish to build with OVS +source code from a different location on the file system, then be sure to +configure and build it before building OVN. .. _general-configuring: