0.6.4

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

diff --git a/ltt/branches/poly/QUICKSTART b/ltt/branches/poly/QUICKSTART
index 75a69a8480b193b83eb34df8db5a2c31b5680598..ca798bdc755935fd8973b637dedc55a6fe10a425 100644 (file)
--- a/ltt/branches/poly/QUICKSTART
+++ b/ltt/branches/poly/QUICKSTART
@@ -13,7 +13,7 @@ What you will typically want is to read sections 1 and 3 : install LTTng from
 binary packages and use it. If there are no packages ready for your system, you
 will have to install from sources (section 2) instead.
 
-These operations are made for installing LTTng 0.2 on a linux 2.6.12-rc2-mm2
+These operations are made for installing LTTng 0.4 on a linux 2.6.12-rc2-mm2
 kernel. Change the versions to fit your needs.
 
 Author : Mathieu Desnoyers, September 2005
@@ -40,7 +40,7 @@ mkdir /usr/src/lttng
 cd /usr/src/lttng
 (see http://ltt.polymtl.ca/lttng for package listing)
 wget http://ltt.polymtl.ca/lttng/lttng-modules-0.2.tar.bz2
-wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.3.bz2
+wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.bz2
 bzip2 -cd lttng-modules-0.2.tar.bz2 | tar xvof -
 
 
@@ -53,15 +53,15 @@ wget http://kernel.org/pub/linux/kernel/people/akpm/patches/2.6/2.6.12-rc4/2.6.1
 bzip2 -cd linux-2.6.12-rc4.tar.bz2 | tar xvof -
 cd linux-2.6.12-rc4
 bzip2 -cd ../2.6.12-rc4-mm2.bz2 | patch -p1
-bzip2 -cd /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.3.bz2 | patch -p1
+bzip2 -cd /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.bz2 | patch -p1
 cd ..
-mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.3
+mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.4
 
 
 * Installing a LTTng kernel
 
 su -
-cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3
+cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4
 make menuconfig
   General setup
     * Linux Trace Toolkit Instrumentation Support
@@ -74,6 +74,11 @@ make
 make install
 make modules_install
 
+The first time you use relayfs, you have to specify a mount point in you system:
+mkdir /mnt/relayfs
+echo "relayfs         /mnt/relayfs    relayfs rw              0       0" \
+   >> /etc/fstab
+
 Depending on your boot loader, you may want to execute :
 update-grub or lilo
 
@@ -84,8 +89,8 @@ reboot
 
 su -
 cd /usr/src/lttng/lttng-modules-0.2
-KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.3 make
-KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.3 make modules_install
+KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4 make
+KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4 make modules_install
 
 note : at this stage, you might want to execute
 modprobe ltt-control
@@ -98,9 +103,9 @@ echo ltt-control >> /etc/modules
 
 su -
 cd /usr/src
-wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.5-16092005.tar.gz
-gzip -cd LinuxTraceToolkitViewer-0.5-16092005.tar.gz | tar xvof -
-cd LinuxTraceToolkitViewer-0.5-16092005
+wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.6.4-21092005.tar.gz
+gzip -cd LinuxTraceToolkitViewer-0.6.4-21092005.tar.gz | tar xvof -
+cd LinuxTraceToolkitViewer-0.6.4-21092005
 (refer to README to see the development libraries that must be installed on you
 system)
 ./configure
@@ -111,19 +116,36 @@ make install
 
 
 ***********************************************************
-** Section 3 * Using LTTV                                **
+** Section 3 * Using LTTng and LTTV                      **
 ***********************************************************
 
-* Use graphical LTTV
+* Use graphical LTTV to control tracing and analyse traces
 
 lttv-gui (or /usr/local/bin/lttv-gui)
-  - Spot the "Trace Control" icon : click on it
+  - Spot the "Tracing Control" icon : click on it
+      (it's a traffic light icon)
     - enter the root password
     - click "start"
     - click "stop"
     - Yes
       * You should now see a trace
 
+* Use text mode LTTng to control tracing
+
+The tracing can be controlled from a terminal by using the lttctl command (as
+root).
+
+Start tracing :
+
+lttctl -n trace -d -l /mnt/relayfs/ltt -t /tmp/trace
+
+Stop tracing and destroy trace channels :
+
+lttctl -n trace -R
+
+see lttctl --help for details.
+
+
 * Use text mode LTTV
 
 Fell free to look in /usr/local/lib/lttv/plugins to see all the text and
@@ -162,14 +184,14 @@ cp process.xml yourfacility.xml
 cd /tmp
 /usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/yourfacility.xml
 cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \
-         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/include/linux/ltt
+         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4/include/linux/ltt
 cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \
-         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/ltt
+         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4/ltt
   * edit the kernel file you want to instrument
     - Add #include <linux/ltt/ltt-facility-yourfacility.h> at the beginning
       of the file.
     - Add a call to the tracing functions. See their names and parameters in
-      /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/include/linux/ltt/ltt-facility-yourfacility.h
+      /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4/include/linux/ltt/ltt-facility-yourfacility.h