X-Git-Url: http://git.lttng.org/?p=ust.git;a=blobdiff_plain;f=README;h=8776ce4577c83e9c0f72b6dbbe98eb6a940451c9;hp=05a6b56ee6b7cadd6360a622764bd7cfdfa786c2;hb=HEAD;hpb=5de791bd1dae05e595ab74016f7333912f2492a8

diff --git a/README b/README
index 05a6b56..8776ce4 100644
--- a/README
+++ b/README
@@ -1,47 +1,41 @@
-LTTNG USERSPACE TRACER
-----------------------
+LTTNG USERSPACE TRACER (UST)
+----------------------------
+
+UST web site and manual: http://lttng.org/ust
 
 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:
 
   - liburcu
-
     Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
-      * Releases: http://lttng.org/files/ust/releases
-      * GitWeb:   http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
-      * Git:      git://lttng.org/userspace-rcu.git
 
-      -> This release was tested with liburcu v0.0
-
-
-  - libkcompat
-
-    Linux kernel userspace compatibility library.
-      (Provides userspace ports of some kernel APIs.)
-      * Releases: http://lttng.org/files/ust/releases
-      * GitWeb:   http://git.dorsal.polymtl.ca (project: libkcompat)
-      * Git:      git://git.dorsal.polymtl.ca/git/libkcompat.git
-
-      -> This release was tested with libkcompat v0.0
+    -> This release depends on liburcu v0.6.6
 
+      * Debian/Ubuntu package: liburcu-dev
+      * 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
 
 
 INSTALLATION INSTRUCTIONS:
 
-  - Download, compile and install liburcu and libkcompat.
+  - Download, compile and install liburcu.
   - In this package's tree, run ./configure.
   - Run make.
   - Run make install.
   - Run ldconfig.
-  - See the manual in the doc/ directory for usage instructions.
+  - See the manual for usage instructions.
 
+  If compiling from the git repository, run ./bootstrap before running
+  the configure script, to generate it.
 
 
 TRACE VIEWER:
@@ -49,6 +43,13 @@ TRACE VIEWER:
   LTTV is used for viewing UST traces. LTTV may be obtained at
   http://lttng.org in the Downloads section.
 
+  This release has been tested with LTTV 0.12.32.
+
+
+CONTACT:
+
+  Maintainer: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+  Mailing list: ltt-dev@lists.casi.polymtl.ca
 
 
 PACKAGE CONTENTS:
@@ -63,18 +64,40 @@ PACKAGE CONTENTS:
     A program to control the tracing of userspace applications. It can list
     markers, start the tracing, stop the tracing, enable/disable markers, etc.
 
-  - ustd
+  - include
+    The public header files that will be installed on the system.
+
+  - ust-consumerd
     The daemon that collects trace data and writes it to the disk.
 
-  - Documentation
+  - doc
+    The documentation.
 
-  - hello
-    An example application that uses the userspace tracer.
+  - tests
+    Various test programs
 
-  - libmallocwrap
+  - libustinstr-malloc
     An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
     in any program without need to recompile it.
 
-  - libinterfork
+  - libustfork
     A library that is LD_PRELOAD'ed, and that hijacks calls to several system
-    calls in order to trace across these calls.
+    calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed
+    in order to hijack calls. In contrast, libust may be linked at build time.
+
+  - libustctl
+    A library to control tracing in other processes. Used by ustctl.
+
+  - libustcomm
+    A static library shared between libust, ust-consumerd and libustctl, that
+    provides functions that allow these components to communicate together.
+
+  - libustconsumer
+    A library to create ust consumers by registering callbacks, used by
+    ust-consumerd.
+
+  - snprintf
+    An asynchronous signal-safe version of snprintf.
+
+  - java
+    A simple library that uses JNI to allow tracing in java programs.