From: Pierre-Marc Fournier <pierre-marc.fournier@polymtl.ca>
Date: Thu, 1 Jul 2010 02:25:25 +0000 (-0400)
Subject: update READMEs
X-Git-Tag: v0.5~4
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=1ffa770bdf4f22dfd0c3be0c0a3af0d2b4cca363;p=ust.git

update READMEs
---

diff --git a/README b/README
index 032fd94..ef11607 100644
--- a/README
+++ b/README
@@ -11,7 +11,6 @@ Updated versions of this package may be found at:
   * Git:      git://git.dorsal.polymtl.ca/git/ust.git
 
 
-
 PREREQUISITES:
 
   - liburcu
@@ -35,6 +34,8 @@ INSTALLATION INSTRUCTIONS:
   - Run ldconfig.
   - See the manual for usage instructions.
 
+  If compiling from the git repository, run ./bootstrap before running
+  the configure script, to generate it.
 
 
 TRACE VIEWER:
@@ -75,7 +76,8 @@ PACKAGE CONTENTS:
 
   - 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.
 
   - libustcmd
     A library to control tracing in other processes. Used by ustctl.
diff --git a/java/README b/java/README
new file mode 100644
index 0000000..358866f
--- /dev/null
+++ b/java/README
@@ -0,0 +1,3 @@
+This directory contains a simple API for instrumenting java applications.
+
+Look at the example in the tests/java directory for usage.
diff --git a/libustcmd/README b/libustcmd/README
new file mode 100644
index 0000000..8c2819a
--- /dev/null
+++ b/libustcmd/README
@@ -0,0 +1,2 @@
+libustcmd is a library that provides an API and its implementation to send
+commands to traceable processes.