Fix: relayd pipes should be closed on exit/error

[lttng-tools.git] / README

diff --git a/README b/README
index 3963f2b40c07732f022388fc928688726f280ea2..033679b7fc3f9147bfd326c57d19ff0dc0f04d46 100644 (file)
--- a/README
+++ b/README
@@ -10,6 +10,10 @@ 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
 
@@ -24,6 +28,8 @@ REQUIREMENTS:
 
       * Debian/Ubuntu package: libpopt-dev
 
+    - For kernel tracing: modprobe
+
 For developers using the git tree:
 
 This source tree is based on the autotools suite from GNU to simplify
@@ -34,6 +40,11 @@ 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/)
+- GNU Gold >= 2.22
+  (Before this version we hit a known bug documented at:
+  http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
+- 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
@@ -57,6 +68,9 @@ 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.
+
 PACKAGE CONTENTS:
 
     This package contains the following elements:
@@ -83,6 +97,9 @@ PACKAGE CONTENTS:
        - libhashtable (internal)
          Library wrapper over URCU hashtables.
 
+       - lttng-relayd
+         The relay daemon used for network streaming
+
     - lttng-consumerd
       The consumer daemon which uses libconsumer.