update READMEs
authorPierre-Marc Fournier <pierre-marc.fournier@polymtl.ca>
Thu, 1 Jul 2010 02:25:25 +0000 (22:25 -0400)
committerPierre-Marc Fournier <pierre-marc.fournier@polymtl.ca>
Thu, 1 Jul 2010 02:25:25 +0000 (22:25 -0400)
README
java/README [new file with mode: 0644]
libustcmd/README [new file with mode: 0644]

diff --git a/README b/README
index 032fd946d7db213fb6af5da03eddead85476eec2..ef11607f633d0fed55e70fa880015b24d940de82 100644 (file)
--- 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 (file)
index 0000000..358866f
--- /dev/null
@@ -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 (file)
index 0000000..8c2819a
--- /dev/null
@@ -0,0 +1,2 @@
+libustcmd is a library that provides an API and its implementation to send
+commands to traceable processes.
This page took 0.025916 seconds and 4 git commands to generate.