datapath: Rename linux-2.6 and compat-2.6 directories.
[sliver-openvswitch.git] / INSTALL.Linux
index c46ab55..c7e4ed9 100644 (file)
@@ -54,6 +54,9 @@ INSTALL.userspace for more information.
       be compiled with IPv6 support (CONFIG_IPV6).  This allows for
       special handling (such as path MTU discovery) of IPv6 packets.
 
+      To configure HTB or HFSC quality of service with Open vSwitch,
+      you must enable the respective configuration options.
+
       To use Open vSwitch support for TAP devices, you must enable
       CONFIG_TUN.
 
@@ -67,8 +70,8 @@ INSTALL.userspace for more information.
       infrastructure.
 
 If you are working from a Git tree or snapshot (instead of from a
-distribution tarball), or if you modify the Open vSwitch build system,
-you will also need the following software:
+distribution tarball), or if you modify the Open vSwitch build system
+or the database schema, you will also need the following software:
 
     - Autoconf version 2.64 or later.
 
@@ -81,12 +84,22 @@ following:
 
     - pyuic4 from PyQt4 (http://www.riverbankcomputing.co.uk).
 
+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:
 
     - "dot" from graphviz (http://www.graphviz.org/).
 
+    - Perl.  Version 5.10.1 is known to work.  Earlier versions should
+      also work.
+
+    - Python 2.x, for x >= 4.
+
 Installation Requirements
 -------------------------
 
@@ -159,17 +172,17 @@ Prerequisites section, follow the procedure below to build.
    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-l26.  For example, to build for a running
-   instance of Linux 2.6:
+   instance of Linux:
 
-      % ./configure --with-l26=/lib/modules/`uname -r`/build
+      % ./configure --with-linux=/lib/modules/`uname -r`/build
 
    If you wish to build the kernel module for an architecture other
    than the architecture of the machine used for the build, you may
    specify the kernel architecture string using the KARCH variable
    when invoking the configure script.  For example, to build for MIPS
-   with Linux 2.6:
+   with Linux:
 
-      % ./configure --with-l26=/path/to/linux-2.6 KARCH=mips
+      % ./configure --with-linux=/path/to/linux KARCH=mips
 
    The configure script accepts a number of other options and honors
    additional environment variables.  For a full list, invoke
@@ -186,7 +199,7 @@ Prerequisites section, follow the procedure below to build.
 
 6. If you built kernel modules, you may load them with "insmod", e.g.:
 
-      % insmod datapath/linux-2.6/openvswitch_mod.ko
+      % insmod datapath/linux/openvswitch_mod.ko
 
    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
@@ -234,9 +247,10 @@ Prerequisites section, follow the procedure below to build.
    whether this is the case. If you know that your particular driver can
    handle it (for example by testing sending large TCP packets over VLANs)
    then passing in a value of 1 may improve performance. Modules built for
-   Linux kernels 2.6.37 and later do not need this and do not have this
-   parameter. If you do not understand what this means or do not know if
-   your driver will work, do not set this.
+   Linux kernels 2.6.37 and later, as well as specially patched versions
+   of earlier kernels, do not need this and do not have this parameter. If
+   you do not understand what this means or do not know if your driver
+   will work, do not set this.
 
 7. Initialize the configuration database using ovsdb-tool, e.g.:
 
@@ -262,6 +276,9 @@ configuration in the database:
                       --bootstrap-ca-cert=db:SSL,ca_cert \
                       --pidfile --detach
 
+(If you built Open vSwitch without SSL support, then omit
+--private-key, --certificate, and --bootstrap-ca-cert.)
+
 Then initialize the database using ovs-vsctl.  This is only
 necessary the first time after you create the database with
 ovsdb-tool (but running it at any time is harmless):