Update README and add version name place-holder

[lttng-modules.git] / README

diff --git a/README b/README
index f4e3368cec50bad0d3f88465d565193617d6abf5..abbfd27746926f6a1426e81ee96b1c4c9e53a4e3 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 LTTng 2.0 modules
 
 Mathieu Desnoyers
-July 19, 2011
+February 8, 2012
 
 LTTng 2.0 kernel modules build against a vanilla or distribution kernel, without
 need for additional patches. Other features:
@@ -36,18 +36,21 @@ the kernel modules when needed. Use Babeltrace to print traces as a
 human-readable text log. These tools are available at the following URL:
 http://lttng.org/lttng2.0
 
-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 Linux kernels 2.6.38, 2.6.39 and 3.0 (on
-x86 32/64-bit, and powerpc 32-bit at the moment, build tested on ARM). It should
-work fine with newer kernels and other architectures, but expect build issues
-with kernels older than 2.6.36. The clock source currently used is the standard
-gettimeofday (slower, less scalable and less precise than the LTTng 0.x clocks).
-Support for LTTng 0.x clocks will be added back soon into LTTng 2.0.  Please
-note that lttng-modules 2.0 can build on a Linux kernel patched with the LTTng
-0.x patchset, but the lttng-modules 2.0 replace the lttng-modules 0.x, so both
-tracers cannot be installed at the same time for a given kernel version.
+So far, it has been tested on vanilla Linux kernels 2.6.38, 2.6.39, 3.0,
+3.1, 3.2, 3.3 (on x86 32/64-bit, and powerpc 32-bit at the moment, build
+tested on ARM). It should work fine with newer kernels and other
+architectures, but expect build issues with kernels older than 2.6.36.
+The clock source currently used is the standard gettimeofday (slower,
+less scalable and less precise than the LTTng 0.x clocks).  Support for
+LTTng 0.x clocks will be added back soon into LTTng 2.0.  Please note
+that lttng-modules 2.0 can build on a Linux kernel patched with the
+LTTng 0.x patchset, but the lttng-modules 2.0 replace the lttng-modules
+0.x, so both tracers cannot be installed at the same time for a given
+kernel version.
+
+LTTng-modules depends on having kallsyms enabled in the kernel it is
+built against. Ideally, if you want to have system call tracing, the
+"Trace Syscalls" feature should be enabled too. 
 
 * Note about Perf PMU counters support