X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=README;h=1898af98472ef7686006bb9bade0024702a5e810;hp=afdbf2311c10da73d195072551b3348ef13a4f14;hb=36907cb5a542b8eb01d95e1990894abd45e98bc0;hpb=aeff77c885be425a8247b2143469fdd400ef68c0

diff --git a/README b/README
index afdbf2311..1898af984 100644
--- a/README
+++ b/README
@@ -10,20 +10,56 @@ 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.5.4
+      -> Tested with liburcu >= v0.6.6
 
       * Debian/Ubuntu package: liburcu-dev
-      * Git : git://lttng.org/userspace-rcu.git
+      * 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
 
+    - SWIG >= 2.0 (optional)
+      Needed for Python bindings
+
+      * Debian/Ubuntu package: swig2.0
+
+    - python-dev (optional)
+      Python headers
+
+      * Debian/Ubuntu package: python-dev
+
+    - For kernel tracing: modprobe
+
+For developers using the git tree:
+
+This source tree is based on the autotools suite from GNU to simplify
+portability. Here are some things you should have on your system in order to
+compile the git repository tree :
+
+- GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
+  (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.
@@ -36,33 +72,62 @@ 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.
 
-    - liblttsessiondcomm
-      The ltt-sessiond communication library. In order to talk with ltt-sessiond,
-      thiis 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.
 
-    - liblttkconsumerd
-      Library for Kernel trace 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.
 
-    - ltt-kconsumerd
-      The Kernel consumer daemon which uses liblttkconsumerd.
+	- libcommon (internal)
+	  Contains multiple useful function call used by the whole tree.
 
-    - ltt-sessiond
+	- 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 libconsumer.
+
+    - lttng-sessiond
       The LTTng session daemon binary.
 
     - lttng
@@ -73,3 +138,9 @@ PACKAGE CONTENTS:
 
     - tests
       Various test programs.
+
+	- doc
+	  Various documentations and quickstart guide.
+
+	- extras
+	  Contains extra data such as bash completion file.