datapath-windows: Make VPORT ovs number values smaller than MAXUINT16

[cascardo/ovs.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index f5e670f..3cfdc04 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -51,7 +51,7 @@ at some cost in features and performance (see INSTALL.userspace for
 details).  To compile the kernel module on Linux, you must also
 install the following:
 
-    - A supported Linux kernel version.  Please refer to README for a
+    - A supported Linux kernel version.  Please refer to README.md for a
       list of supported versions.
 
       The Open vSwitch datapath requires bridging support
@@ -67,8 +67,10 @@ install the following:
       obsolete and not needed.)
 
       To use GRE tunneling on Linux 2.6.37 or newer, kernel support
-      for GRE must be compiled in or available as a module
-      (CONFIG_NET_IPGRE_DEMUX).
+      for GRE demultiplexing (CONFIG_NET_IPGRE_DEMUX) must be compiled
+      in or available as a module.  Also, on kernels before 3.11, the
+      ip_gre module, for GRE tunnels over IP (NET_IPGRE), must not be
+      loaded or compiled in.
 
       To configure HTB or HFSC quality of service with Open vSwitch,
       you must enable the respective configuration options.
@@ -89,7 +91,7 @@ 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
 or the database schema, you will also need the following software:
 
-    - Autoconf version 2.64 or later.
+    - Autoconf version 2.63 or later.
 
     - Automake version 1.10 or later.
 
@@ -380,7 +382,7 @@ of Open vSwitch, make sure that the new userspace version is compatible with
 the previously loaded kernel module.
 
 2. An upgrade of userspace daemons means that they have to be restarted.
-Restarting the daemons means that the Openflow flows in the ovs-vswitchd daemon
+Restarting the daemons means that the OpenFlow flows in the ovs-vswitchd daemon
 will be lost.  One way to restore the flows is to let the controller
 re-populate it.  Another way is to save the previous flows using a utility
 like ovs-ofctl and then re-add them after the restart. Restoring the old flows
@@ -551,6 +553,49 @@ test failures that you believe to represent bugs in Open vSwitch.
 Include the precise versions of Open vSwitch and Ryu in your bug
 report, plus any other information needed to reproduce the problem.
 
+Continuous Integration with Travis-CI
+-------------------------------------
+
+A .travis.yml file is provided to automatically build Open vSwitch with
+various build configurations and run the testsuite using travis-ci.
+Builds will be performed with gcc, sparse and clang with the -Werror
+compiler flag included, therefore the build will fail if a new warning
+has been introduced.
+
+The CI build is triggered via git push (regardless of the specific
+branch) or pull request against any Open vSwitch GitHub repository that
+is linked to travis-ci.
+
+Instructions to setup travis-ci for your GitHub repository:
+
+1. Go to http://travis-ci.org/ and sign in using your GitHub ID.
+2. Go to the "Repositories" tab and enable the ovs repository. You
+   may disable builds for pushes or pull requests.
+3. In order to avoid forks sending build failures to the upstream
+   mailing list, the notification email recipient is encrypted. If you
+   want to receive email notification for build failures, replace the
+   the encrypted string:
+   3.1) Install the travis-ci CLI (Requires ruby >=2.0):
+           gem install travis
+   3.2) In your Open vSwitch repository:
+           travis encrypt mylist@mydomain.org
+   3.3) Add/replace the notifications section in .travis.yml and fill
+        in the secure string as returned by travis encrypt:
+
+         notifications:
+           email:
+             recipients:
+               - secure: "....."
+
+   (You may remove/omit the notifications section to fall back to
+    default notification behaviour which is to send an email directly
+    to the author and committer of the failing commit. Note that the
+    email is only sent if the author/committer have commit rights for
+    the particular GitHub repository).
+
+4. Pushing a commit to the repository which breaks the build or the
+   testsuite will now trigger a email sent to mylist@mydomain.org
+
 Bug Reporting
 =============