Fix: liblttng-ust-fork Makefile flags mismatch

[lttng-ust.git] / README

diff --git a/README b/README
index 71d7188460a5ab159f65e6a5b4f50ec5c55135d0..71bae95b6d62303a9261a754dbefc44c3897a008 100644 (file)
--- 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:
@@ -16,7 +16,7 @@ PREREQUISITES:
   - liburcu
     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
 
-    -> This release depends on liburcu v0.6.6
+    -> This release depends on liburcu v0.7.2
 
       * Debian/Ubuntu package: liburcu-dev
       * Website:  http://lttng.org/urcu
@@ -24,6 +24,9 @@ PREREQUISITES:
       * GitWeb:   http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
       * Git:      git://lttng.org/userspace-rcu.git
 
+  - libuuid (for Linux)
+      * Debian/Ubuntu package: libuuid1, uuid-dev
+
 For developers using the git tree:
 
 This source tree is based on the autotools suite from GNU to simplify
@@ -56,24 +59,51 @@ USAGE:
 
   - Create an instrumentation header following the tracepoint examples.
     See lttng/tracepoint.h, and examples.
-  - Either compile the Tracepoint probes with the application:
+
+  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 -llttng-ust".
+    - Link application with "-ldl" on Linux, with "-lc" on BSD.
+    - 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 "-llttng-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
-  - Or compile the Tracepoint probes separately from the application,
-    using dynamic linking:
+      - 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".
+    - Link application with "-ldl" on Linux, "-lc" on BSD.
     - Set a LD_PRELOAD environment to preload the tracepoint provider
       shared object before starting the application when tracing is
-      needed.
+      needed. Another way is to dlopen the tracepoint probe when needed
+      by the application.
     - Example:
       - tests/demo/   demo.c  tp*.c ust_tests_demo*.h demo-trace
+
   - Enable instrumentation and control tracing with the "lttng" command
     from lttng-tools. See lttng-tools doc/quickstart.txt.
+  - Note about dlclose() usage: it is not safe to use dlclose on a
+    provider shared object that is being actively used for tracing due
+    to a lack of reference counting from lttng-ust to the used shared
+    object.
 
 ENVIRONMENT VARIABLES:
 
@@ -90,6 +120,10 @@ ENVIRONMENT VARIABLES:
     recommended for applications with time constraints on the process
     startup time.
 
+  - The compilation flag "-DLTTNG_UST_DEBUG_VALGRIND" should be enabled
+    at build time to allow liblttng-ust to be used with valgrind
+    (side-effect: disables per-cpu buffering).
+
 
 TRACE VIEWER:
 
@@ -100,7 +134,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:
@@ -117,7 +151,7 @@ PACKAGE CONTENTS:
   - tests
     Various test programs
 
-  - liblttng-ust-libc
+  - 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.