diff mbox series

[ovs-dev] docs: Clarify that OVS submodule should not be used to build OVS itself.

Message ID 20210311203819.2526788-1-i.maximets@ovn.org
State Accepted
Headers show
Series [ovs-dev] docs: Clarify that OVS submodule should not be used to build OVS itself. | expand

Commit Message

Ilya Maximets March 11, 2021, 8:38 p.m. UTC 
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@ovn.org>
---
 Documentation/intro/install/general.rst | 29 ++++++++++++++++---------
 1 file changed, 19 insertions(+), 10 deletions(-)

Comments

Ben Pfaff March 11, 2021, 10:31 p.m. UTC | #1 
On Thu, Mar 11, 2021 at 09:38:19PM +0100, Ilya Maximets wrote:
> 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@ovn.org>

I think that this is an improvement.  Thanks.

Acked-by: Ben Pfaff <blp@ovn.org>
Mark Michelson March 12, 2021, 1:10 a.m. UTC | #2 
On 3/11/21 5:31 PM, Ben Pfaff wrote:
> On Thu, Mar 11, 2021 at 09:38:19PM +0100, Ilya Maximets wrote:
>> 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@ovn.org>
> 
> I think that this is an improvement.  Thanks.
> 
> Acked-by: Ben Pfaff <blp@ovn.org>
> 

Thanks I merged this to master and branch-21.03.
diff mbox series

Patch

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 <https://www.openvswitch.org/download/>`_ 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: