From patchwork Wed Nov 4 07:02:41 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ben Pfaff X-Patchwork-Id: 1393676 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=140.211.166.137; helo=fraxinus.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=ovn.org Received: from fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4CQyKj0KzMz9sTK for ; Wed, 4 Nov 2020 18:03:21 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by fraxinus.osuosl.org (Postfix) with ESMTP id 6F74D86909; Wed, 4 Nov 2020 07:03:19 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from fraxinus.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id v6ftls2M4QRt; Wed, 4 Nov 2020 07:03:17 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by fraxinus.osuosl.org (Postfix) with ESMTP id 06A9B867ED; Wed, 4 Nov 2020 07:03:15 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id EC038C088B; Wed, 4 Nov 2020 07:03:14 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from hemlock.osuosl.org (smtp2.osuosl.org [140.211.166.133]) by lists.linuxfoundation.org (Postfix) with ESMTP id 0C32BC0893 for ; Wed, 4 Nov 2020 07:03:13 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by hemlock.osuosl.org (Postfix) with ESMTP id B407D87532 for ; Wed, 4 Nov 2020 07:03:12 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from hemlock.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id dB+AK1u2Qxw2 for ; Wed, 4 Nov 2020 07:03:09 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by hemlock.osuosl.org (Postfix) with ESMTPS id DBB55874E7 for ; Wed, 4 Nov 2020 07:03:05 +0000 (UTC) X-Originating-IP: 75.54.222.30 Received: from sigfpe.attlocal.net (75-54-222-30.lightspeed.rdcyca.sbcglobal.net [75.54.222.30]) (Authenticated sender: blp@ovn.org) by relay7-d.mail.gandi.net (Postfix) with ESMTPSA id 564E32000D; Wed, 4 Nov 2020 07:03:02 +0000 (UTC) From: Ben Pfaff To: dev@openvswitch.org Date: Tue, 3 Nov 2020 23:02:41 -0800 Message-Id: <20201104070246.2847579-8-blp@ovn.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: <20201104070246.2847579-1-blp@ovn.org> References: <20201104070246.2847579-1-blp@ovn.org> MIME-Version: 1.0 Cc: Ben Pfaff Subject: [ovs-dev] [PATCH ovn 07/12] Documentation: Update repo information and prerequisites. 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" At the time this was written, there weren't any OVN releases independent of OVS, but now there are so we should mention them. Also, I don't think it's worth talking about compilers other than the three listed. We haven't tested with them. Signed-off-by: Ben Pfaff Acked-by: Numan siddique --- Documentation/intro/install/general.rst | 27 ++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst index 80f1c9dfb71f..75bf29ba6b75 100644 --- a/Documentation/intro/install/general.rst +++ b/Documentation/intro/install/general.rst @@ -39,12 +39,23 @@ repository, which you can clone into a directory named "ovn" with:: Cloning the repository leaves the "master" branch initially checked out. This is the right branch for general development. +If, on the other hand, if you want to build a particular released +version, you can check it out by running a command such as the +following from the "ovs" directory:: -As of now there are no official OVN releases. + $ git checkout v20.09.0 -Before building OVN you should configure and build OVS. -Please see the Open vSwitch documentation (https://docs.openvswitch.org/en/latest/intro/install/) -to build and install OVS https://github.com/openvswitch/ovs.git +The repository also has a branch for each release series. For +example, to obtain the latest fixes in the Open vSwitch 2.7.x release +series, which might include bug fixes that have not yet been in any +released version, you can check it out from the "ovs" directory with:: + + $ git checkout origin/branch-20.09 + +If you do not want to use Git, you can also obtain tarballs for `OVN +release versions `, or download a +ZIP file for any snapshot from the `GitHub web interface +`. .. _general-build-reqs: @@ -54,9 +65,11 @@ Build Requirements To compile the userspace programs in the OVN distribution, you will need the following software: +- Open vSwitch (https://docs.openvswitch.org/en/latest/intro/install/). + - GNU make -- A C compiler, such as: +- One of the following C compilers: - GCC 4.6 or later. @@ -65,10 +78,6 @@ need the following software: - MSVC 2013. Refer to :doc:`windows` for additional Windows build instructions. -- While OVN may be compatible with other compilers, optimal support for atomic - operations may be missing, making OVN very slow - (see ``ovs/lib/ovs-atomic.h``). - - libssl, from OpenSSL, is optional but recommended if you plan to connect the OVN services to the OVN DB ovsdb-servers securely. If libssl is installed, then OVN will automatically build with support for it.