X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=README;h=3d7e18e3de27f59a124de7ecbf0a9d4f64f5ec9c;hb=18c1cd87c54290691f0e6913f84c16fa5267b86d;hp=ef11607f633d0fed55e70fa880015b24d940de82;hpb=1ffa770bdf4f22dfd0c3be0c0a3af0d2b4cca363;p=lttng-ust.git

diff --git a/README b/README
index ef11607f..3d7e18e3 100644
--- a/README
+++ b/README
@@ -7,8 +7,8 @@ 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:
@@ -16,7 +16,7 @@ PREREQUISITES:
   - liburcu
     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-    -> This release was tested with liburcu v0.4.3
+    -> This release depends on liburcu v0.6
 
       * Debian/Ubuntu package: liburcu-dev
       * Website:  http://lttng.org/urcu
@@ -38,12 +38,31 @@ INSTALLATION INSTRUCTIONS:
   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)
+
+  Note: libust debug can be activated by either of the following means:
+    - Setting the environment variable "UST_DEBUG" when launching the
+      application.
+    - Compiling libust with -DUST_DEBUG.
+
+
 TRACE VIEWER:
 
   LTTV is used for viewing UST traces. LTTV may be obtained at
   http://lttng.org in the Downloads section.
 
-  This release has been tested with LTTV 0.12.30.
+  This release has been tested with LTTV 0.12.32.
+
+
+CONTACT:
+
+  Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+  Mailing list: ltt-dev@lists.casi.polymtl.ca
 
 
 PACKAGE CONTENTS:
@@ -61,7 +80,7 @@ PACKAGE CONTENTS:
   - include
     The public header files that will be installed on the system.
 
-  - ustd
+  - ust-consumerd
     The daemon that collects trace data and writes it to the disk.
 
   - doc
@@ -79,12 +98,16 @@ PACKAGE CONTENTS:
     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.
 
-  - libustcmd
+  - libustctl
     A library to control tracing in other processes. Used by ustctl.
 
   - libustcomm
-    A static library shared between libust, ustd and libustcmd, that provides
-    functions that allow these components to communicate together.
+    A static library shared between libust, ust-consumerd and libustctl, that
+    provides functions that allow these components to communicate together.
+
+  - libustconsumer
+    A library to create ust consumers by registering callbacks, used by
+    ust-consumerd.
 
   - snprintf
     An asynchronous signal-safe version of snprintf.