X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=README;h=e2b52aa026f74a3ff598c774bc034baefe01c5aa;hb=4846fadcf9aebf5ec93dc6614aa36ddfe29a3898;hp=0b0d4bd3915a22b3ff624feb667ec67086ff41e1;hpb=efac0f0fe7c961fadf067115c7e6279cf6ff2bac;p=lttng-ust.git

diff --git a/README b/README
index 0b0d4bd3..e2b52aa0 100644
--- a/README
+++ b/README
@@ -1,14 +1,14 @@
-LTTNG USERSPACE TRACER (UST)
+LTTNG USERSPACE TRACER (LTTng-UST)
 ----------------------------
 
-UST web site and manual: http://lttng.org/ust
+UST web site: http://lttng.org/lttng2.0
 
 Updated versions of this package may be found at:
 
-  * Website:  http://lttng.org/ust
-  * Releases: http://lttng.org/files/ust/releases
-  * GitWeb:   http://git.lttng.org (project: ust)
-  * Git:      git://git.lttng.org/ust.git
+  * Website:  http://lttng.org/lttng2.0
+  * Releases: http://lttng.org/files/lttng-ust
+  * GitWeb:   http://git.lttng.org (project: lttng-ust)
+  * Git:      git://git.lttng.org/lttng-ust.git
 
 
 PREREQUISITES:
@@ -47,7 +47,6 @@ INSTALLATION INSTRUCTIONS:
   - 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.
@@ -56,9 +55,52 @@ INSTALLATION INSTRUCTIONS:
 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)
+    See lttng/tracepoint.h, and examples.
+
+  There are 2 ways to compile the Tracepoint Provider with the
+  application: either statically or dynamically. Please follow
+  carefully:
+
+  1.1) Compile the Tracepoint provider with the application, either
+       directly or through a static library (.a):
+    - Into exactly one object of your application: define
+      "TRACEPOINT_DEFINE" and include the tracepoint provider.
+    - Use "-I." for the compilation unit containing the tracepoint
+      provider include (e.g. tp.c).
+    - Link application with "-ldl".
+    - If building the provider directly into the application,
+      link the application with "-llttng-ust".
+    - If building a static library for the provider, link the static
+      library with "-lllttng-ust".
+    - Include the tracepoint provider header into all C files using
+      the provider.
+    - Example:
+        tests/hello/  hello.c tp.c ust_tests_hello.h Makefile.example
+
+  2) Compile the Tracepoint Provider separately from the application,
+     using dynamic linking:
+    - Into exactly one object of your application: define
+      "TRACEPOINT_DEFINE" _and_ also define
+      "TRACEPOINT_PROBE_DYNAMIC_LINKAGE", then include the tracepoint
+      provider header.
+    - Include the tracepoint provider header into all instrumented C
+      files that use the provider.
+    - Compile the tracepoint provider with "-I.".
+    - Link the tracepoint provider with "-llttng-ust".
+    - Link application with "-ldl".
+    - Set a LD_PRELOAD environment to preload the tracepoint provider
+      shared object before starting the application when tracing is
+      needed.
+    - Example:
+      - tests/demo/   demo.c  tp*.c ust_tests_demo*.h demo-trace
+
+  - Note about dlopen() usage: due to locking side-effects due to the
+    way libc lazily resolves Thread-Local Storage (TLS) symbols when a
+    library is dlopen'd, linking the tracepoint probe or liblttng-ust
+    with dlopen() is discouraged. They should be linked with the
+    application using "-llibname" or loaded with LD_PRELOAD.
+  - Enable instrumentation and control tracing with the "lttng" command
+    from lttng-tools. See lttng-tools doc/quickstart.txt.
 
 ENVIRONMENT VARIABLES:
 
@@ -71,7 +113,9 @@ ENVIRONMENT VARIABLES:
     "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".
+    -1 means "wait forever". Setting this environment variable to 0 is
+    recommended for applications with time constraints on the process
+    startup time.
 
 
 TRACE VIEWER:
@@ -83,7 +127,7 @@ TRACE VIEWER:
 CONTACT:
 
   Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
-  Mailing list: ltt-dev@lists.casi.polymtl.ca
+  Mailing list: lttng-dev@lists.lttng.org
 
 
 PACKAGE CONTENTS:
@@ -97,15 +141,13 @@ PACKAGE CONTENTS:
   - include
     The public header files that will be installed on the system.
 
-  - doc
-    The documentation.
-
   - tests
     Various test programs
 
-  - 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.
+  - liblttng-ust-libc-wrapper
+    An example library that can be LD_PRELOAD'ed to instrument some
+    calls to libc (currently malloc() and free()) in any program without
+    need to recompile it.
 
   - liblttng-ust-fork
     A library that is LD_PRELOAD'ed, and that hijacks calls to several system
@@ -119,9 +161,12 @@ PACKAGE CONTENTS:
     A static library shared between libust and lttng-tools, that
     provides functions that allow these components to communicate together.
 
+  - libringbuffer
+    The ring buffer implementation used within LTTng-UST.
+
   - snprintf
     An asynchronous signal-safe version of snprintf.
 
-  - java
+  - liblttng-ust-java
     A simple library that uses JNI to allow tracing in java programs.
-    See java/README for build instructions.
+    See liblttng-ust-java/README for build instructions.