[ovs-dev] [PATCH ovn] docs: Clarify that OVS submodule should not be used to build OVS itself.
i.maximets at ovn.org
Thu Mar 11 20:38:19 UTC 2021
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 <i.maximets at ovn.org>
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
@@ -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
+ 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 <https://www.openvswitch.org/download/>`_ or packages
+ provided in your distribution.
- GNU make
@@ -157,8 +166,8 @@ the "configure" script::
-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::
$ 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.
More information about the dev