Document how to get Open vSwitch source code.

Suggested-by: "Nadathur, Sundar" <[email protected]> Signed-off-by: Ben Pfaff <[email protected]> Acked-by: Gurucharan Shetty <[email protected]>
caozhiyuan · Mar 29, 2017 · 0f2e8b6 · 0f2e8b6
1 parent 9d99234
commit 0f2e8b6
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -514,6 +514,7 @@ Stepan Andrushko                [email protected]
 Stephen Hemminger               [email protected]
 Stuart Cardall                  [email protected]
 Suganya Ramachandran            [email protected]
+Sundar Nadathur                 [email protected]
 Taekho Nam                      [email protected]
 Takayuki HAMA                   [email protected]
 Teemu Koponen                   [email protected]

diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst
@@ -29,6 +29,34 @@ This document describes how to build and install Open vSwitch on a generic
 Linux, FreeBSD, or NetBSD host. For specifics around installation on a specific
 platform, refer to one of the other installation guides listed in :doc:`index`.
 
+Obtaining Open vSwitch Sources
+------------------------------
+
+The canonical location for Open vSwitch source code is its Git
+repository, which you can clone into a directory named "ovs" with::
+
+    $ git clone https://github.com/openvswitch/ovs.git
+
+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::
+
+    $ git checkout v2.7.0
+
+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-2.7
+
+If you do not want to use Git, you can also obtain tarballs for Open
+vSwitch release versions via http://openvswitch.org/download/, or
+download a ZIP file for any snapshot from the web interface at
+https://github.com/openvswitch/ovs.
+
 .. _general-build-reqs:
 
 Build Requirements