library mass rename: add lttng- prefix

[ust.git] / liblttng-ust-malloc / README

diff --git a/liblttng-ust-malloc/README b/liblttng-ust-malloc/README
new file mode 100644 (file)
index 0000000..c58a7e6
--- /dev/null
+++ b/liblttng-ust-malloc/README
@@ -0,0 +1,9 @@
+libustinstr-malloc is used for instrumenting calls to malloc(3) in a program,
+without need for recompiling it.
+
+libustinstr-malloc defines a malloc() function that is instrumented with a
+marker. It also calls the libc malloc afterwards. When loaded with LD_PRELOAD,
+it replaces the libc malloc() function, in effect instrumenting all calls to
+malloc().
+
+See the "run" script for a usage example.