todo update

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

diff --git a/ltt/branches/poly/QUICKSTART b/ltt/branches/poly/QUICKSTART
index 3c094fce825ed40efc45c803f9ff86fef971d08c..5d4eb00abb7f1214c77a66a450f3d97e3d24c696 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.
 
 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 the LTTng 0.4.1 tracer on a
+These operations are made for installing the LTTng 0.4.3 tracer on a

 linux 2.6.12-rc4-mm2 kernel. You will also find instructions for installtion of
 LTTV 0.6.x : the Linux Trace Toolkit Viewer.
 
 linux 2.6.12-rc4-mm2 kernel. You will also find instructions for installtion of
 LTTV 0.6.x : the Linux Trace Toolkit Viewer.
 


@@ -50,8 +50,20 @@ Author : Mathieu Desnoyers, September 2005
 ** Section 1 * Installation from Debian or RPM packages  **
 ***********************************************************
 
 ** Section 1 * Installation from Debian or RPM packages  **
 ***********************************************************
 

-No RPM packages are ready yet.
-No Debian kernel LTTng patch is ready yet.
+* Install from RPM packages on Fedora Core 4 :
+
+Get LTTV RPM from :
+
+http://ltt.polymtl.ca/packages/fedora/RPMS
+
+LTTV RPM are ready.
+
+LTTng kernel and lttng-modules RPM are available for some architectures (i586,
+i686). Feel free to help fix the spec files to have correct lttng-modules RPM
+package.
+
+
+* Install from Deb packages on Debian :

 
 You can use the ltt.polymtl.ca apt source to get LTTV for Debian :
 
 
 You can use the ltt.polymtl.ca apt source to get LTTV for Debian :
 


@@ -67,8 +79,8 @@ deb-src http://ltt.polymtl.ca/packages/debian experimental main
 su -
 apt-get update
 apt-get install lttv lttv-doc
 su -
 apt-get update
 apt-get install lttv lttv-doc

-apt-get install kernel-image-2.6.12-rc4-mm2-lttng-0.4.1
-apt-get install lttng-modules-modules-2.6.12-rc4-mm2-lttng-0.4.1
+apt-get install kernel-image-2.6.12-rc4-mm2-lttng-0.4.2
+apt-get install lttng-modules-modules-2.6.12-rc4-mm2-lttng-0.4.2

   * note : the packages are signed by myself. I am not considered a trusted
     Debian source yet, so warnings are normal.
 
   * note : the packages are signed by myself. I am not considered a trusted
     Debian source yet, so warnings are normal.
 


@@ -82,7 +94,7 @@ packages for other platforms, do :
 su -
 cd /usr/src
 apt-get source lttv
 su -
 cd /usr/src
 apt-get source lttv

-cd lttv-0.6.7
+cd lttv-0.6.9

 dpkg-buildpackage -rfakeroot
 
 You should then have your LTTV .deb files created for your architecture.
 dpkg-buildpackage -rfakeroot
 
 You should then have your LTTV .deb files created for your architecture.


@@ -92,10 +104,10 @@ You should then have your LTTV .deb files created for your architecture.
 For building LTTng Debian packages :
 
 su -
 For building LTTng Debian packages :
 
 su -

-apt-get install kernel-source-2.6.12-rc4-mm2-lttng-0.4.1
+apt-get install kernel-source-2.6.12-rc4-mm2-lttng-0.4.2

 cd /usr/src
 cd /usr/src

-bzip2 -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.1.tar.bz2 | tar xvof -
-cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.1
+bzip2 -cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2.tar.bz2 | tar xvof -
+cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2

 make menuconfig (or xconfig or config) (customize your configuration)
 make-kpkg kernel_image
 
 make menuconfig (or xconfig or config) (customize your configuration)
 make-kpkg kernel_image
 


@@ -107,7 +119,7 @@ You will also need to create a package for the lttng-modules :
 su -
 cd /usr/src
 apt-get source lttng-modules
 su -
 cd /usr/src
 apt-get source lttng-modules

-cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.1
+cd kernel-source-2.6.12-rc4-mm2-lttng-0.4.2

 make-kpkg --added_modules /usr/src/lttng-modules-0.3 modules_image
 
 You will then see your freshly created .deb in /usr/src. Install it with
 make-kpkg --added_modules /usr/src/lttng-modules-0.3 modules_image
 
 You will then see your freshly created .deb in /usr/src. Install it with


@@ -145,11 +157,24 @@ configuration menu, but there are alternatives.
 
 Prerequisites for LTTV 0.6.x installation are :
 
 
 Prerequisites for LTTV 0.6.x installation are :
 

-gtk 2.4 or better development libraries (libgtk2.0, libgtk2.0-dev)
-glib 2.4 or better development libraries (libglib2.0-0, libglib2.0-dev)
-libpopt development libraries (libpopt0, libpopt-dev)
-libpango development libraries (libpango1.0, libpango1.0-dev)
-libc6 development librairies (libc6, libc6-dev)
+gcc 3.2 or better
+gtk 2.4 or better development libraries
+  (Debian : libgtk2.0, libgtk2.0-dev)
+  (Fedora : gtk2, gtk2-devel)
+  note : For Fedora users : this might require at least core 3 from Fedora,
+  or you might have to compile your own GTK2 library.
+glib 2.4 or better development libraries
+  (Debian : libglib2.0-0, libglib2.0-dev)
+  (Fedora : glib2, glib2-devel)
+libpopt development libraries
+  (Debian : libpopt0, libpopt-dev)
+  (Fedora : popt)
+libpango development libraries
+  (Debian : libpango1.0, libpango1.0-dev)
+  (Fedora : pango, pango-devel)
+libc6 development librairies 
+  (Debian : libc6, libc6-dev)
+  (Fedora : glibc, glibc)

 
 
 * Getting the LTTng packages
 
 
 * Getting the LTTng packages


@@ -159,8 +184,9 @@ 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.3.tar.bz2
 cd /usr/src/lttng
 (see http://ltt.polymtl.ca/lttng for package listing)
 wget http://ltt.polymtl.ca/lttng/lttng-modules-0.3.tar.bz2

-wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.1.bz2
+wget http://ltt.polymtl.ca/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.3.tar.bz2

 bzip2 -cd lttng-modules-0.3.tar.bz2 | tar xvof -
 bzip2 -cd lttng-modules-0.3.tar.bz2 | tar xvof -

+bzip2 -cd patch-2.6.12-rc4-mm2-lttng-0.4.3.tar.bz2 | tar xvof -

 
 
 * Getting LTTng kernel sources
 
 
 * Getting LTTng kernel sources


@@ -172,15 +198,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 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.4.1.bz2 | patch -p1
+cat /usr/src/lttng/patch-2.6.12-rc4-mm2-lttng-0.4.3-* | patch -p1

 cd ..
 cd ..

-mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.4.1
+mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.4.3

 
 
 * Installing a LTTng kernel
 
 su -
 
 
 * Installing a LTTng kernel
 
 su -

-cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.1
+cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.3

 make menuconfig (or make xconfig or make config)
     Select the < Help > button if you are not familiar with kernel
     configuration.
 make menuconfig (or make xconfig or make config)
     Select the < Help > button if you are not familiar with kernel
     configuration.


@@ -206,15 +232,15 @@ make install
 
 reboot
 
 
 reboot
 

-  Select the Linux 2.6.12-rc4-mm2-lttng-0.4.1 kernel in your boot loader.
+  Select the Linux 2.6.12-rc4-mm2-lttng-0.4.3 kernel in your boot loader.

 
 
 * Install the ltt-modules
 
 su -
 cd /usr/src/lttng/lttng-modules-0.3
 
 
 * Install the ltt-modules
 
 su -
 cd /usr/src/lttng/lttng-modules-0.3

-KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.1 make
-KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.1 make modules_install
+KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.3 make
+KERNELDIR=/usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.3 make modules_install

 
 
 * Editing the system wide configuration
 
 
 * Editing the system wide configuration


@@ -246,9 +272,9 @@ echo ltt-control >> /etc/modules
 
 su -
 cd /usr/src
 
 su -
 cd /usr/src

-wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.6.5-21092005.tar.gz
-gzip -cd LinuxTraceToolkitViewer-0.6.5-21092005.tar.gz | tar xvof -
-cd LinuxTraceToolkitViewer-0.6.5-21092005
+wget http://ltt.polymtl.ca/packages/LinuxTraceToolkitViewer-0.6.9-10102005.tar.gz
+gzip -cd LinuxTraceToolkitViewer-0.6.9-10102005.tar.gz | tar xvof -
+cd LinuxTraceToolkitViewer-0.6.9-10102005

 (refer to README to see the development libraries that must be installed on you
 system)
 ./configure
 (refer to README to see the development libraries that must be installed on you
 system)
 ./configure


@@ -325,16 +351,16 @@ cd /usr/local/share/LinuxTraceToolkitViewer/facilities
 cp process.xml yourfacility.xml
   * edit yourfacility.xml to fit your needs.
 cd /tmp
 cp process.xml yourfacility.xml
   * edit yourfacility.xml to fit your needs.
 cd /tmp

-/usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/yourfacility.xml
+/usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/facilities/yourfacility.xml

 cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \
 cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \

-         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.1/include/linux/ltt
+         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.3/include/linux/ltt

 cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \
 cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \

-         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.1/ltt
+         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.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
   * 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.4.1/include/linux/ltt/ltt-facility-yourfacility.h
+      /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4.3/include/linux/ltt/ltt-facility-yourfacility.h