Version 2.5.7

[lttng-ust.git] / README

diff --git a/README b/README
index 30ccb34d1a57903c2822f3618442b23571ef2fda..1d731ab76c4d8d8ab1fe787f12d51d4adda7bc8a 100644 (file)
--- a/README
+++ b/README
@@ -21,7 +21,7 @@ PREREQUISITES:
       * Website:  http://lttng.org/urcu
       * Releases: http://lttng.org/files/urcu
       * GitWeb:   http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
-      * Git:      git://lttng.org/userspace-rcu.git
+      * Git:      git://git.urcu.so/userspace-rcu.git
 
 For developers using the git tree:
 
@@ -52,6 +52,13 @@ 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. Note that LTTng-UST needs to
+  be a shared library, even if the tracepoint probe provider is statically
+  linked into the application.
 
 USAGE:
 
@@ -72,11 +79,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:
@@ -94,14 +104,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: since LTTng-UST 2.3, both tracepoints and
+    tracepoint probes can be compiled in C++. To compile tracepoint probes
+    in C++, you need g++ >= 4.7 or Clang.
+
 
 ENVIRONMENT VARIABLES: