Update README, TODO and CodingStyle

[lttng-tools.git] / README

diff --git a/README b/README
index 1d736dc7982366096fa6d4c606c59cb9058c099c..fe9e4c2b1c87c05b4c8c959d7be6920ad6a94ab9 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
 
@@ -19,11 +23,13 @@ REQUIREMENTS:
       * Git : git://git.lttng.org/userspace-rcu.git
       * Website:  http://lttng.org/urcu
 
-    - libpopt
+    - libpopt >= 1.13
       Library for parsing command line parameters
 
       * 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,12 +40,16 @@ 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
 tree configuration.
 
-
 INSTALLATION INSTRUCTIONS:
 
   - Download, compile and install the prerequisites.
@@ -58,25 +68,49 @@ 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:
 
-    - 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 +123,9 @@ PACKAGE CONTENTS:
 
     - tests
       Various test programs.
+
+       - doc
+         Various documentations and quickstart guide.
+
+       - extras
+         Contains extra data such as bash completion file.