[ovs-dev] doc: Minor improvements to install instructions.

Submitted by Ben Pfaff on March 17, 2017, 9:40 p.m.

Details

Message ID 20170317214008.26806-1-blp@ovn.org
State Accepted
Headers show

Commit Message

Ben Pfaff March 17, 2017, 9:40 p.m.
Clang 3.4 and later should now be widespread, so it's not worth suggesting
where to find it.

OVS needs a variety of shared libraries at runtime and it's not worth
mentioning each one by name.

The Linux kernel datapath module is available from a variety of places, so
don't say you have to use the one you built.

Signed-off-by: Ben Pfaff <blp@ovn.org>
---
 Documentation/intro/install/general.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

Comments

andy zhou March 29, 2017, 5:27 p.m.
On Fri, Mar 17, 2017 at 2:40 PM, Ben Pfaff <blp@ovn.org> wrote:
> Clang 3.4 and later should now be widespread, so it's not worth suggesting
> where to find it.
>
> OVS needs a variety of shared libraries at runtime and it's not worth
> mentioning each one by name.
>
> The Linux kernel datapath module is available from a variety of places, so
> don't say you have to use the one you built.
>
> Signed-off-by: Ben Pfaff <blp@ovn.org>
Acked-by: Andy Zhou <azhou@ovn.org>
Ben Pfaff March 29, 2017, 6:15 p.m.
On Wed, Mar 29, 2017 at 10:27:34AM -0700, Andy Zhou wrote:
> On Fri, Mar 17, 2017 at 2:40 PM, Ben Pfaff <blp@ovn.org> wrote:
> > Clang 3.4 and later should now be widespread, so it's not worth suggesting
> > where to find it.
> >
> > OVS needs a variety of shared libraries at runtime and it's not worth
> > mentioning each one by name.
> >
> > The Linux kernel datapath module is available from a variety of places, so
> > don't say you have to use the one you built.
> >
> > Signed-off-by: Ben Pfaff <blp@ovn.org>
> Acked-by: Andy Zhou <azhou@ovn.org>

Thanks, applied to master.

Patch hide | download patch | download mbox

diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst
index b2c3c20de419..9e77bcf7ea68 100644
--- a/Documentation/intro/install/general.rst
+++ b/Documentation/intro/install/general.rst
@@ -43,9 +43,7 @@  need the following software:
 
   - GCC 4.6 or later.
 
-  - Clang. Clang 3.4 and later provide useful static semantic analysis and
-    thread-safety checks. For Ubuntu, there are nightly built packages
-    available on clang's website.
+  - Clang 3.4 or later.
 
   - MSVC 2013. Refer to :doc:`windows` for additional Windows build
     instructions.
@@ -164,12 +162,14 @@  Installation Requirements
 The machine you build Open vSwitch on may not be the one you run it on. To
 simply install and run Open vSwitch you require the following software:
 
-- libc compatible with the libc used for build.
+- Shared libraries compatible with those used for the build.
 
-- libssl compatible with the libssl used for build, if OpenSSL was used
-  for the build.
-
-- On Linux, the same kernel version configured as part of the build.
+- On Linux, if you want to use the kernel-based datapath (which is the most
+  common use case), then a kernel with a compatible kernel module.  This
+  can be a kernel module built with Open vSwitch (e.g. in the previous
+  step), or the kernel module that accompanies Linux 3.3 and later.  Open
+  vSwitch features and performance can vary based on the module and the
+  kernel.  Refer to :doc:`/internals/releases` for more information.
 
 - For optional support of ingress policing on Linux, the "tc" program
   from iproute2 (part of all major distributions and available at