clang: Add annotations for thread safety check.

[sliver-openvswitch.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 5589fe7..a0eb266 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -28,6 +28,11 @@ 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.
+

 To compile the kernel module on Linux, you must also install the
 following.  If you cannot build or install the kernel module, you may
 use the userspace-only implementation, at a cost in performance.  The
 To compile the kernel module on Linux, you must also install the
 following.  If you cannot build or install the kernel module, you may
 use the userspace-only implementation, at a cost in performance.  The


@@ -107,6 +112,8 @@ 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
 Also, you may find the ovs-dev script found in utilities/ovs-dev.py useful.
 
 Installation Requirements


@@ -173,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