X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=README;h=746b1666fabb2de3ddcd3be4222a56f6494cb02e;hb=refs%2Fheads%2Flttng-ust-2.0;hp=a68e8707183a3e8a0456c0ac7499d262b84137e8;hpb=cb974fbd91bf27bfda124e8c30227e548a802585;p=ust.git

diff --git a/README b/README
index a68e870..746b166 100644
--- a/README
+++ b/README
@@ -5,80 +5,108 @@ UST web site and manual: http://lttng.org/ust
 
 Updated versions of this package may be found at:
 
+  * Website:  http://lttng.org/ust
   * Releases: http://lttng.org/files/ust/releases
-  * GitWeb:   http://git.dorsal.polymtl.ca (project: ust)
-  * Git:      git://git.dorsal.polymtl.ca/git/ust.git
-
+  * GitWeb:   http://git.lttng.org (project: ust)
+  * Git:      git://git.lttng.org/ust.git
 
 
 PREREQUISITES:
 
   - liburcu
-
     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
-      * Releases: http://lttng.org/files/ust/releases
-      * GitWeb:   http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
-      * Git:      git://lttng.org/userspace-rcu.git
-
-      -> This release was tested with liburcu v0.4.1
-
 
-  - libkcompat
-
-    Linux kernel userspace compatibility library.
-      (Provides userspace ports of some kernel APIs.)
-      * Releases: http://lttng.org/files/ust/releases
-      * GitWeb:   http://git.dorsal.polymtl.ca (project: libkcompat)
-      * Git:      git://git.dorsal.polymtl.ca/git/libkcompat.git
-
-      -> This release was tested with libkcompat v0.1
+    -> This release depends on liburcu v0.6.6
 
+      * Debian/Ubuntu package: liburcu-dev
+      * Website:  http://lttng.org/urcu
+      * Releases: http://lttng.org/files/urcu
+      * GitWeb:   http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
+      * Git:      git://lttng.org/userspace-rcu.git
 
 
 INSTALLATION INSTRUCTIONS:
 
-  - Download, compile and install liburcu and libkcompat.
+  - Download, compile and install liburcu.
   - In this package's tree, run ./configure.
   - Run make.
   - Run make install.
   - Run ldconfig.
   - See the manual for usage instructions.
 
+  If compiling from the git repository, run ./bootstrap before running
+  the configure script, to generate it.
+
+
+USAGE:
+
+  - Create an instrumentation header following the tracepoint examples.
+    (see tracepoint.h and tests/hello/tp.h).
+  - Link application with -lust.
+  - (TODO: start tracing with the "lttng" command from lttng-tools)
+
+ENVIRONMENT VARIABLES:
+
+  - liblttng-ust debug can be activated by setting the environment variable
+    "LTTNG_UST_DEBUG" when launching the application. It can also be enabled
+    at compile-time by compiling libust with -DLTTNG_UST_DEBUG.
+
+  - The environment variable "LTTNG_UST_REGISTER_TIMEOUT" can be used to
+    specify how long the applications should wait for sessiond
+    "registration done" command before proceeding to execute the main
+    program. The default is 3000ms (3 seconds). The timeout value is
+    specified in milliseconds. The value 0 means "don't wait". The value
+    -1 means "wait forever".
 
 
 TRACE VIEWER:
 
-  LTTV is used for viewing UST traces. LTTV may be obtained at
-  http://lttng.org in the Downloads section.
+  Use babeltrace for viewing traces generated by LTTng UST 2.0.
+  See http://lttng.org for download.
+
+
+CONTACT:
 
-  This release has been tested with LTTV 0.12.30.
+  Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+  Mailing list: ltt-dev@lists.casi.polymtl.ca
 
 
 PACKAGE CONTENTS:
 
   This package contains the following elements.
 
-  - libust
+  - liblttng-ust
     The actual userspace tracing library that must be linked to the
     instrumented programs.
 
-  - ustctl
-    A program to control the tracing of userspace applications. It can list
-    markers, start the tracing, stop the tracing, enable/disable markers, etc.
-
-  - ustd
-    The daemon that collects trace data and writes it to the disk.
+  - include
+    The public header files that will be installed on the system.
 
   - doc
     The documentation.
 
-  - hello
-    An example application that uses the userspace tracer.
+  - tests
+    Various test programs
 
-  - libmallocwrap
+  - liblttng-ust-malloc
     An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
     in any program without need to recompile it.
 
-  - libinterfork
+  - liblttng-ust-fork
     A library that is LD_PRELOAD'ed, and that hijacks calls to several system
-    calls in order to trace across these calls.
+    calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed
+    in order to hijack calls. In contrast, libust may be linked at build time.
+
+  - liblttng-ust-ctl
+    A library to control tracing in other processes. Used by lttng-tools.
+
+  - liblttng-ust-comm
+    A static library shared between libust and lttng-tools, that
+    provides functions that allow these components to communicate together.
+
+  - snprintf
+    An asynchronous signal-safe version of snprintf.
+
+  - java
+    A simple library that uses JNI to allow tracing in java programs.
+    See java/README for build instructions.