Add UST_DEBUG env. var. support

[lttng-ust.git] / README

diff --git a/README b/README
index f4a01016a0e7394fe68de5c8e658d13c03f815d5..3d7e18e3de27f59a124de7ecbf0a9d4f64f5ec9c 100644 (file)
--- 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 depends on liburcu v0.5.5
+    -> This release depends on liburcu v0.6
 
       * Debian/Ubuntu package: liburcu-dev
       * Website:  http://lttng.org/urcu
@@ -38,6 +38,19 @@ 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