Update README
[lttng-modules.git] / README
diff --git a/README b/README
index 48ac65727aec9d6056ed2f4e4c38b75c8b1c7461..745e563d3e5c3e3268d0467c276fea35d436be48 100644 (file)
--- a/README
+++ b/README
@@ -11,25 +11,31 @@ need for additional patches. Other features:
 - Function tracer, perf counters and kprobes support,
 - Integrated interface for both kernel and userspace tracing,
 - Have the ability to attach "context" information to events in the
-  trace (e.g. any perf counter, pid, ppid, tid, comm name, etc). So
-  basically, all the perf "required fields" like "preempt count" and
-  "bkl count" are all optional, specified on a per-tracing-session basis
+  trace (e.g. any perf counter, pid, ppid, tid, comm name, etc).
+  basically, all the extra information fields to be collected with
+  events are optional, specified on a per-tracing-session basis
   (except for timestamp and event id, which are mandatory).
 
 To build and install, you will need to have your kernel headers available (or
 access to your full kernel source tree), and use:
 
 make
-make install
+make modules_install
 
 If you need to specify the target directory to the kernel you want to build
 against, use:
 
 KERNELDIR=path_to_kernel_dir make
-KERNELDIR=path_to_kernel_dir make install
+KERNELDIR=path_to_kernel_dir make modules_install
 
-Use lttng-tools to control the tracer. LTTng tools should automatically load the
-kernel modules when needed.
+Use lttng-tools (git://git.lttng.org/lttng-tools.git) to control the tracer.
+LTTng tools should automatically load the kernel modules when needed.
+
+Use Babeltrace (git://git.efficios.com/babeltrace.git) to print traces as a
+human-readable text log.
+
+Please note that the LTTng-UST 2.0 (user-space tracing counterpart of LTTng 2.0)
+is still in active development and not released yet.
 
 So far, it has been tested on vanilla kernels 2.6.38 and 2.6.39 (on x86 at the
 moment). It should work fine with newer kernels and other architectures, but
This page took 0.023575 seconds and 4 git commands to generate.