Merge branch 'mainstream'

[sliver-openvswitch.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 4749e30..95ee898 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


@@ -88,9 +94,8 @@ To run the unit tests, you also need:
     - Perl.  Version 5.10.1 is known to work.  Earlier versions should
       also work.
 
     - 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/).
 


@@ -107,6 +112,10 @@ installing the following to obtain better warnings:
 
     - GNU make.
 
 
     - GNU make.
 

+    - clang, version 3.4 or later
+
+Also, you may find the ovs-dev script found in utilities/ovs-dev.py useful.
+

 Installation Requirements
 -------------------------
 
 Installation Requirements
 -------------------------
 


@@ -171,6 +180,10 @@ Prerequisites section, follow the procedure below to build.
 
       % ./configure CC=gcc-4.2
 
 
       % ./configure CC=gcc-4.2
 

+   To use 'clang' compiler:
+
+      % ./configure CC=clang
+

    To build the Linux kernel module, so that you can run the
    kernel-based switch, pass the location of the kernel build
    directory on --with-linux.  For example, to build for a running
    To build the Linux kernel module, so that you can run the
    kernel-based switch, pass the location of the kernel build
    directory on --with-linux.  For example, to build for a running


@@ -186,6 +199,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.


@@ -209,15 +227,15 @@ Prerequisites section, follow the procedure below to build.
 6. Run "make install" to install the executables and manpages into the
    running system, by default under /usr/local.
 
 6. Run "make install" to install the executables and manpages into the
    running system, by default under /usr/local.
 

-7. If you built kernel modules, you may load them with "insmod", e.g.:
+7. If you built kernel modules, you may install and load them, e.g.:

 
 

-      % insmod datapath/linux/openvswitch.ko
+      % make modules_install
+      % /sbin/modprobe openvswitch 

 
 

-   You may need to specify a full path to insmod, e.g. /sbin/insmod.

    To verify that the modules have been loaded, run "/sbin/lsmod" and
    check that openvswitch is listed.
 
    To verify that the modules have been loaded, run "/sbin/lsmod" and
    check that openvswitch is listed.
 

-   If the "insmod" operation fails, look at the last few kernel log
+   If the "modprobe" operation fails, look at the last few kernel log

    messages (e.g. with "dmesg | tail"):
 
       - The message "openvswitch: exports duplicate symbol
    messages (e.g. with "dmesg | tail"):
 
       - The message "openvswitch: exports duplicate symbol


@@ -264,11 +282,6 @@ Prerequisites section, follow the procedure below to build.
    you do not understand what this means or do not know if your driver
    will work, do not set this.
 
    you do not understand what this means or do not know if your driver
    will work, do not set this.
 

-   Once you verify that the kernel modules load properly, you should
-   install them:
-
-      % make modules_install
-

 8. Initialize the configuration database using ovsdb-tool, e.g.:
 
       % mkdir -p /usr/local/etc/openvswitch
 8. Initialize the configuration database using ovsdb-tool, e.g.:
 
       % mkdir -p /usr/local/etc/openvswitch