Replace __COUNTER__ with the more portable __LINE__

[ust.git] / README

diff --git a/README b/README
index 18874e81d8065cd034d42e241ae981ed0bf1b761..47904d4922ac6144a41fcfa1353c2aec5b21002f 100644 (file)
--- a/README
+++ b/README
@@ -1,18 +1,28 @@
 LTTNG USERSPACE TRACER
 
-NOTE: THIS LIBRARY HAS NOT BEEN RELEASED YET BECAUSE ALTOUGH IT IS LICENCED AS
-LGPL, IT CAN ONLY BE USED AS GPL BECAUSE IT DEPENDS ON GPL LIBRARIES. IT WILL BE
-RELEASED AS SOON AS THESE ISSUES ARE RESOLVED.
+Updated versions of this package may be found at:
+       git://git.dorsal.polymtl.ca/git/ust.git
 
 Dependencies:
 
-- liburcu-pmf
-  Userspace RCU library, pmf patches.
-  http://git.dorsal.polymtl.ca
+- liburcu
+  Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
+   * http://ltt.polymtl.ca/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary
+   * git://lttng.org/userspace-rcu.git
 
 - libkcompat
   Linux kernel userspace compatibility library.
-  http://git.dorsal.polymtl.ca
+   * http://git.dorsal.polymtl.ca
+   * git://git.dorsal.polymtl.ca/git/libkcompat.git
+
+Installation instruction:
+
+- Download, compile and install liburcu and libkcompat.
+- In this package's tree, run ./configure.
+- Run make.
+- Run make install.
+- Run ldconfig.
+- See the manual in the doc/ directory for usage instructions.
 
 Package contents:
 
@@ -20,7 +30,7 @@ Package contents:
   The actual userspace tracing library that must be linked to the
   instrumented programs.
 
-- ust
+- ustctl
   A program to control the tracing of userspace applications. It can list
   markers, start the tracing, stop the tracing, enable/disable markers, etc.
 
@@ -35,3 +45,7 @@ Package contents:
 - libmallocwrap
   An example library that can be LD_PRELOAD'ed to instrument calls to malloc()
   in any program without need to recompile it.
+
+- libinterfork
+  A library that is LD_PRELOAD'ed, and that hijacks calls to several system
+  calls in order to trace across these calls.