INSTALL.Linux: Document use of "sparse" with Open vSwitch.
authorBen Pfaff <blp@nicira.com>
Mon, 30 Apr 2012 19:59:11 +0000 (12:59 -0700)
committerBen Pfaff <blp@nicira.com>
Mon, 30 Apr 2012 21:00:51 +0000 (14:00 -0700)
Signed-off-by: Ben Pfaff <blp@nicira.com>
INSTALL.Linux

index 0d3c31025a7e54466e6d5f3bdadfbd5671f5ad8b..78152b6940f7a6a5b04847d014b38a7c6352d121 100644 (file)
@@ -100,6 +100,14 @@ you have the following:
 
     - Python 2.x, for x >= 4.
 
+If you are going to extensively modify Open vSwitch, please consider
+installing the following to obtain better warnings:
+
+    - "sparse" version 0.4.4 or later
+      (http://www.kernel.org/pub/software/devel/sparse/dist/).
+
+    - GNU make.
+
 Installation Requirements
 -------------------------
 
@@ -187,6 +195,9 @@ Prerequisites section, follow the procedure below to build.
 
       % make
 
+   For improved warnings if you installed "sparse" (see
+   "Prerequisites"), add C=1 to the "make" command line.
+
 4. Become root by running "su" or another program.
 
 5. Run "make install" to install the executables and manpages into the