X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=ltt%2Fbranches%2Fpoly%2FQUICKSTART;h=8fe0b5f5a42f890e5a6d785087976de29051d9c3;hb=916ec268f37ffaa360642b249d08f011d078cdec;hp=7d98e22760f5506e4f65c4e40db561339191b547;hpb=02bc6879ab351394e64678a55959c0ab635304d4;p=lttv.git

diff --git a/ltt/branches/poly/QUICKSTART b/ltt/branches/poly/QUICKSTART
index 7d98e227..8fe0b5f5 100644
--- a/ltt/branches/poly/QUICKSTART
+++ b/ltt/branches/poly/QUICKSTART
@@ -3,12 +3,36 @@ QUICKSTART
 
 How to use LTTng and LTTV in a few lines :
 
+This document is made of four parts : The first one explains how to install
+LTTng and LTTV from Debian and RPM binary packages, the second one explains how
+to install LTTng and LTTV from sources and the third one describes the steps
+to follow to trace a system and view it. The fourth and last part explains
+briefly how to add a new trace point to the kernel.
+
+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
 kernel. Change the versions to fit your needs.
 
 Author : Mathieu Desnoyers, September 2005
 
 
+
+***********************************************************
+** Section 1 * Installation from Debian or RPM packages  **
+***********************************************************
+
+No Debian or RPM packages are ready yet.
+
+TODO
+
+
+***********************************************************
+** Section 2 * Installation from sources                 **
+***********************************************************
+
 * Getting the LTTng packages
 
 su -
@@ -16,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.2.bz2
+wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.3.bz2
 bzip2 -cd lttng-modules-0.2.tar.bz2 | tar xvof -
 
 
@@ -29,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.2.bz2 | patch -p1
+bzip2 -cd /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.3.bz2 | patch -p1
 cd ..
-mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.2
+mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.3
 
 
 * Installing a LTTng kernel
 
 su -
-cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.2
+cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3
 make menuconfig
   General setup
     * Linux Trace Toolkit Instrumentation Support
@@ -49,6 +73,10 @@ make menuconfig
 make
 make install
 make modules_install
+
+Depending on your boot loader, you may want to execute :
+update-grub or lilo
+
 reboot
 
 
@@ -56,8 +84,8 @@ reboot
 
 su -
 cd /usr/src/lttng/lttng-modules-0.2
-KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.2 make
-KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.2 make modules_install
+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
 
 note : at this stage, you might want to execute
 modprobe ltt-control
@@ -77,7 +105,14 @@ cd LinuxTraceToolkitViewer-0.5-16092005
 make
 make install
 
-* Use LTTV
+
+
+
+***********************************************************
+** Section 3 * Using LTTV                                **
+***********************************************************
+
+* Use graphical LTTV
 
 lttv-gui (or /usr/local/bin/lttv-gui)
   - Spot the "Trace Control" icon : click on it
@@ -87,6 +122,23 @@ lttv-gui (or /usr/local/bin/lttv-gui)
     - Yes
       * You should now see a trace
 
+* Use text mode LTTV
+
+Fell free to look in /usr/local/lib/lttv/plugins to see all the text and
+graphical plugins available.
+
+For example, a simple trace dump in text format is available with :
+
+lttv -m textDump -t /tmp/trace
+
+see lttv -m textDump --help for detailed command line options of textDump.
+
+
+
+
+***********************************************************
+** Section 4 * Adding new instrumentations with genevent **
+***********************************************************
 
 * Getting and installing genevent
 
@@ -108,14 +160,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.2/include/linux/ltt
+         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/include/linux/ltt
 cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \
-         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.2/ltt
+         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/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.2/include/linux/ltt/ltt-facility-yourfacility.h
+      /usr/src/linux-2.6.12-rc4-mm2-lttng-0.3/include/linux/ltt/ltt-facility-yourfacility.h