update LTT viewing tools README

[lttv.git] / ltt / branches / poly / QUICKSTART

diff --git a/ltt/branches/poly/QUICKSTART b/ltt/branches/poly/QUICKSTART
index 60320757cfa34ca7b2e1c18c5cfa0bc3d1c8680a..a47a5ee25f614305f9d4c8d0d4e32d1ddb4f8a64 100644 (file)
--- a/ltt/branches/poly/QUICKSTART
+++ b/ltt/branches/poly/QUICKSTART
@@ -208,7 +208,9 @@ cd /usr/src
 wget http://kernel.org/pub/linux/kernel/v2.6/linux-2.6.X.tar.bz2
 bzip2 -cd linux-2.6.X.tar.bz2 | tar xvof -
 cd linux-2.6.X
-cat /usr/src/lttng/patch*-2.6.X-lttng-0.x.xx* | patch -p1
+- For LTTng 0.9.4- cat /usr/src/lttng/patch*-2.6.X-lttng-0.x.xx* | patch -p1
+- For LTTng 0.9.5+ apply the patches in the order specified in the series file,
+  or use quilt
 cd ..
 mv linux-2.6.X linux-2.6.X-lttng-0.x.xx
 
@@ -431,7 +433,7 @@ make
 make install
 
 
-* Add new events to the kernel with genevent
+* Add new events to the kernel with genevent (deprecated in LTTng 0.9.x)
 
 su -
 cd /usr/local/share/ltt-control/facilities
@@ -449,9 +451,22 @@ cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \
     will be connected to your marker and will typically call the logging
     functions found in the header file you created with genevent.
 
+* Add new kernel events
+
+*Important* note : in its current state, LTTng and LTTV needs the programmer
+to keep the marker/probe format string and the XML description of the
+event data types in sync by hand. Failure to do so will result in errors in
+LTTV.
+
+See the markers documentation to see how to describe the marker. You will need
+to clone probe modules found in ltt/probes to connect them to the markers so
+that the information can be recorded in the trace.
+
 * Add new events to userspace programs with genevent
 See http://ltt.polymtl.ca/ > USERSPACE TRACING QUICKSTART
 
+User-space tracing still uses genevent, which is subject to change in a near
+future.