Merge branch 'master' of ssh://git.onelab.eu/git/sliver-openvswitch

[sliver-openvswitch.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index a0eb266..001d3cb 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -9,6 +9,7 @@ on a specific platform, please see one of these files:
     - INSTALL.Fedora
     - INSTALL.RHEL
     - INSTALL.XenServer
     - INSTALL.Fedora
     - INSTALL.RHEL
     - INSTALL.XenServer

+    - INSTALL.NetBSD

 
 Build Requirements
 ------------------
 
 Build Requirements
 ------------------


@@ -18,8 +19,13 @@ you will need the following software:
 
     - GNU make.
 
 
     - GNU make.
 

-    - The GNU C compiler.  We generally test with version 4.1, 4.2, or
-      4.3.
+    - A C compiler, such as:
+
+        * GCC 4.x.
+
+        * 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.

 
     - libssl, from OpenSSL, is optional but recommended if you plan to
       connect the Open vSwitch to an OpenFlow controller.  libssl is
 
     - libssl, from OpenSSL, is optional but recommended if you plan to
       connect the Open vSwitch to an OpenFlow controller.  libssl is


@@ -28,10 +34,7 @@ you will need the following software:
       libssl is installed, then Open vSwitch will automatically build
       with support for it.
 
       libssl is installed, then Open vSwitch will automatically build
       with support for it.
 

-    - clang, from LLVM, is optional. It provides useful static semantic
-      analyzer and thread-safety check. clang version must be 3.4 or
-      later. For Ubuntu, there are nightly built packages available on
-      clang's website.
+    - Python 2.x, for x >= 4.

 
 To compile the kernel module on Linux, you must also install the
 following.  If you cannot build or install the kernel module, you may
 
 To compile the kernel module on Linux, you must also install the
 following.  If you cannot build or install the kernel module, you may


@@ -81,21 +84,15 @@ or the database schema, you will also need the following software:
 
     - Automake version 1.10 or later.
 
 
     - Automake version 1.10 or later.
 

-    - Python 2.x, for x >= 4.
-
-If you modify the ovsdbmonitor tool, then you will also need the
-following:
-
-    - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk).
+    - libtool version 2.4 or later.  (Older versions might work too.)

 
 To run the unit tests, you also need:
 
     - Perl.  Version 5.10.1 is known to work.  Earlier versions should
       also work.
 
 
 To run the unit tests, you also need:
 
     - Perl.  Version 5.10.1 is known to work.  Earlier versions should
       also work.
 

-If you modify the vswitchd database schema, then the E-R diagram in
-the ovs-vswitchd.conf.db(5) manpage will be updated properly only if
-you have the following:
+The ovs-vswitchd.conf.db(5) manpage will include an E-R diagram, in
+formats other than plain text, only if you have the following:

 
     - "dot" from graphviz (http://www.graphviz.org/).
 
 
     - "dot" from graphviz (http://www.graphviz.org/).
 


@@ -136,22 +133,6 @@ following software:
 On Linux you should ensure that /dev/urandom exists.  To support TAP
 devices, you must also ensure that /dev/net/tun exists.
 
 On Linux you should ensure that /dev/urandom exists.  To support TAP
 devices, you must also ensure that /dev/net/tun exists.
 

-To run the ovsdbmonitor tool, the machine must also have the following
-software:
-
-    - Python 2.x, for x >= 4.
-
-    - Python Twisted Conch.
-
-    - Python JSON.
-
-    - PySide or PyQt4.
-
-    - Python Zope interface module.
-
-(On Debian "lenny" the above can be installed with "apt-get install
-python-json python-qt4 python-zopeinterface python-twisted-conch".)
-

 Building and Installing Open vSwitch for Linux, FreeBSD or NetBSD
 =================================================================
 
 Building and Installing Open vSwitch for Linux, FreeBSD or NetBSD
 =================================================================
 


@@ -199,6 +180,11 @@ Prerequisites section, follow the procedure below to build.
 
       % ./configure --with-linux=/path/to/linux KARCH=mips
 
 
       % ./configure --with-linux=/path/to/linux KARCH=mips
 

+   If you plan to do much Open vSwitch development, you might want to
+   add --enable-Werror, which adds the -Werror option to the compiler
+   command line, turning warnings into errors.  That makes it
+   impossible to miss warnings generated by the build.
+

    The configure script accepts a number of other options and honors
    additional environment variables.  For a full list, invoke
    configure with the --help option.
    The configure script accepts a number of other options and honors
    additional environment variables.  For a full list, invoke
    configure with the --help option.