Fix: epoll attributes used outside of compat layer

[lttng-tools.git] / README

diff --git a/README b/README
index 5cd5650034c982bd10ae68c22da747e7296fec2d..9aab80f1c4df570eec600a8ed5b3e48949ed3183 100644 (file)
--- a/README
+++ b/README
@@ -10,20 +10,47 @@ Latest development can be found at:
 
 REQUIREMENTS:
 
+       - Linux kernel >= 2.6.27
+         pipe2(), epoll_create1() and SOCK_CLOEXEC are needed to run the session
+         daemon. There were introduce in the Linux 2.6.27
+
     - liburcu
       Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-      -> Tested with liburcu >= v0.6.6
+      -> Tested with liburcu >= v0.7.2
 
       * Debian/Ubuntu package: liburcu-dev
       * Git : git://git.lttng.org/userspace-rcu.git
       * Website:  http://lttng.org/urcu
 
-    - libpopt >= 1.8
+    - libpopt >= 1.13
       Library for parsing command line parameters
 
       * Debian/Ubuntu package: libpopt-dev
 
+    - Perl (optional)
+      Needed for make check and tests.
+
+    - Python >= 3.0 (optional)
+      Needed for make check and tests.
+
+      * Debian/Ubuntu package: python3
+
+    - SWIG >= 2.0 (optional)
+      Needed for Python bindings (--enable-python-bindings).
+
+      * Debian/Ubuntu package: swig2.0
+
+    - python-dev (optional)
+      Python headers
+
+      * Debian/Ubuntu package: python-dev
+
+    - For kernel tracing: modprobe
+
+       - bash
+         Needed for running "make check".
+
 For developers using the git tree:
 
 This source tree is based on the autotools suite from GNU to simplify
@@ -34,16 +61,25 @@ compile the git repository tree :
   (make sure your system wide "automake" points to a recent version!)
 - GNU Libtool >=2.2
   (for more information, go to http://www.gnu.org/software/autoconf/)
+- flex >= 2.5.35
+- bison >= 2.4
 
-If you get the tree from the repository, you will need to use the "bootstrap"
-script in the root of the tree. It calls all the GNU tools needed to prepare the
-tree configuration.
+If you use GNU gold, which is NOT mandatory, make sure you have this version:
+- GNU gold >= 2.22
+(Before this version we hit a known bug documented at:
+ http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
+Be advise that with GNU gold, you'll might have to specify -L/usr/local/lib in
+LDFLAGS.
 
+If you get the tree from the repository, you will need to use the "bootstrap"
+script in the root of the tree. It calls all the GNU tools needed to prepare
+the tree configuration.
 
 INSTALLATION INSTRUCTIONS:
 
   - Download, compile and install the prerequisites.
   Then:
+  $ ./boostrap
   $ ./configure
   $ make
   $ sudo make install
@@ -52,31 +88,60 @@ INSTALLATION INSTRUCTIONS:
   If compiling from the git repository, run ./bootstrap before running
   the configure script, to generate it.
 
+  If you want Python bindings, run ./configure --enable-python-bindings.
+
 USAGE:
 
 Please see doc/quickstart.txt to help you start tracing. You can also use the
 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
 lttng enable-event -h).
 
+A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
+helps you understand how to stream a LTTng 2.0 trace.
+
+A Python HOWTO can be found in doc/python-howto.txt which quickly
+helps you understand how to use the Python module to control the LTTng API.
+
 PACKAGE CONTENTS:
 
     This package contains the following elements:
 
-    - liblttngctl
+    - liblttng-ctl
       The LTTng tracing control library.
 
-    - liblttng-sessiond-comm
-      The lttng-sessiond communication library. In order to talk with lttng-sessiond,
-      this library must be used.
+    - libsessiond-comm (internal)
+         The lttng-sessiond communication library. In order to talk with
+         lttng-sessiond, this library must be used.
 
-    - libkernelctl
+    - libkernel-ctl (internal)
       Kernel tracer control and ioctl definitions.
 
-    - liblttng-consumer
+    - libconsumer (internal)
       Library for Kernel and (optionally) UST trace consumer.
 
+       - libkernel-consumer (internal)
+         Library for Kernel consumer control
+
+       - libust-consumer (internal)
+         Library for UST consumer control
+
+       - libhashtable (internal)
+         Library wrapper over URCU hashtables.
+
+       - libcommon (internal)
+         Contains multiple useful function call used by the whole tree.
+
+       - libcompat (internal)
+         Compatibility library mostly for FreeBSD and Linux.
+       
+       - librelayd (internal)
+         Library for all relayd interactions over the network.
+
+       - lttng-relayd
+         The relay daemon used for network streaming
+
     - lttng-consumerd
-      The consumer daemon which uses liblttng-consumer.
+      The consumer daemon which uses libconsumer.
 
     - lttng-sessiond
       The LTTng session daemon binary.
@@ -89,3 +154,9 @@ PACKAGE CONTENTS:
 
     - tests
       Various test programs.
+
+       - doc
+         Various documentations and quickstart guide.
+
+       - extras
+         Contains extra data such as bash completion file.