Version 2.2.3

[lttng-ust.git] / README

diff --git a/README b/README
index 84cc69133953e8fd9e85ebc81e2dd3c8a443a6c4..2a335ceccac6d2cddecf82591525c56e8aecc7f4 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,11 @@
 LTTNG USERSPACE TRACER (LTTng-UST)
 ----------------------------
 
-UST web site: http://lttng.org/lttng2.0
+UST web site: http://lttng.org
 
 Updated versions of this package may be found at:
 
-  * Website:  http://lttng.org/lttng2.0
-  * Releases: http://lttng.org/files/lttng-ust
+  * Releases: http://lttng.org/download
   * GitWeb:   http://git.lttng.org (project: lttng-ust)
   * Git:      git://git.lttng.org/lttng-ust.git
 
@@ -53,6 +52,11 @@ INSTALLATION INSTRUCTIONS:
   If compiling from the git repository, run ./bootstrap before running
   the configure script, to generate it.
 
+  Note that configure sets '/usr/local' as the default prefix for files it
+  installs. However, this path is not part of most distributions' default
+  library path which will cause builds depending on liblttng-ust to fail unless
+  '-L/usr/local/lib' is added to LDFLAGS. You may provide a custom prefix to
+  configure by using the --prefix switch.
 
 USAGE:
 
@@ -73,11 +77,14 @@ USAGE:
     - 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".
+      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.*
+    - Examples:
+      - doc/examples/easy-ust/   sample.c sample_component_provider.h
+        tp.c Makefile
+      - doc/examples/hello-static-lib/   hello.c tp.c ust_test_hello.h
+        Makefile
 
   2) Compile the Tracepoint Provider separately from the application,
      using dynamic linking:
@@ -95,14 +102,18 @@ USAGE:
       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
+      - doc/examples/demo   demo.c  tp*.c ust_tests_demo*.h demo-trace Makefile
 
-  - 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.
+  - Enable instrumentation and control tracing with the "lttng" command
+    from lttng-tools. See lttng-tools doc/quickstart.txt.
+  - Note for C++ support: although an application instrumented with
+    tracepoints can be compiled with g++, tracepoint probes should be
+    compiled with gcc (only tested with gcc so far).
+
 
 ENVIRONMENT VARIABLES:
 
@@ -126,7 +137,7 @@ ENVIRONMENT VARIABLES:
 
 TRACE VIEWER:
 
-  Use babeltrace for viewing traces generated by LTTng UST 2.0.
+  Use babeltrace for viewing traces generated by LTTng UST 2.x.
   See http://lttng.org for download.