[ovs-dev] [PATCH ovn 07/12] Documentation: Update repo information and prerequisites.

Ben Pfaff blp at ovn.org
Wed Nov 4 07:02:41 UTC 2020


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 <blp at ovn.org>
---
 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 <https://www.ovn.org/en/releases/>`, or download a
+ZIP file for any snapshot from the `GitHub web interface
+<https://github.com/ovn-org/ovn>`.
 
 .. _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.
-- 
2.26.2



More information about the dev mailing list