QUICKSTART comments from Michel

git-svn-id: http://ltt.polymtl.ca/svn@1256 04897980-b3bd-0310-b5e0-8ef037075253

diff --git a/ltt/branches/poly/QUICKSTART b/ltt/branches/poly/QUICKSTART
index ca798bdc755935fd8973b637dedc55a6fe10a425..fc9f3a085ccaaa999cf7b7061c2326e455833f85 100644 (file)
--- a/ltt/branches/poly/QUICKSTART
+++ b/ltt/branches/poly/QUICKSTART
@@ -13,8 +13,21 @@ 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.4 on a linux 2.6.12-rc2-mm2
-kernel. Change the versions to fit your needs.
+These operations are made for installing the LTTng 0.4 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.
+
+At this point, the -mm tree of the kernel is used because it has RelayFS support
+in it. In a nearby future, a vanilla kernel 2.6.14 will be used, as RelayFS has
+been integrated in the linux 2.6.14-rc series.
+
+The following lttng patch is necessary to have the tracing hooks in the kernel.
+The following ltt-control module controls the tracing.
+
+Required programs and librairies are assumed to be automatically installed in an
+installation with Debian or RPM packages. In the case of an installation from
+sources, the dependencies are listed.
+
 
 Author : Mathieu Desnoyers, September 2005
 
@@ -33,6 +46,37 @@ TODO
 ** Section 2 * Installation from sources                 **
 ***********************************************************
 
+* Prerequisites
+
+Tools needed to follow the package download steps :
+
+o wget
+o bzip2
+o gzip
+o tar
+
+You have to install the standard development librairies and programs necessary
+to compile a kernel :
+
+(from Documentation/Changes in the Linux kernel tree)
+o  Gnu C                  2.95.3                  # gcc --version
+o  Gnu make               3.79.1                  # make --version
+o  binutils               2.12                    # ld -v
+o  util-linux             2.10o                   # fdformat --version
+o  module-init-tools      0.9.10                  # depmod -V
+
+You might also want to have libncurses5 to have the text mode kernel
+configuration menu, but there are alternatives.
+
+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)
+
+
 * Getting the LTTng packages
 
 su -
@@ -62,28 +106,39 @@ mv linux-2.6.12-rc4 linux-2.6.12-rc4-mm2-lttng-0.4
 
 su -
 cd /usr/src/linux-2.6.12-rc4-mm2-lttng-0.4
-make menuconfig
-  General setup
-    * Linux Trace Toolkit Instrumentation Support
-    M or * Linux Trace Toolkit Tracer
+make menuconfig (or make xconfig or make config)
+    Select the < Help > button if you are not familiar with kernel
+    configuration.
+    Items preceded by [*] means they has to be built into the kernel.
+    Items preceded by [M] means they has to be built as modules.
+    Items preceded by [ ] means they should be removed.
+  go to the "General setup" section
+    Select the following options :
+    [*] Linux Trace Toolkit Instrumentation Support
+    [M] or [*] Linux Trace Toolkit Tracer
     do NOT activate (not ready yet) :
-        Align Linux Trace Toolkit Traces
-        Activate Linux Trace Toolkit Heartbeat Timer
+       [ ] Align Linux Trace Toolkit Traces
+       [ ] Activate Linux Trace Toolkit Heartbeat Timer
               IMPORTANT : This is enabled by default : you must disable it!
+    Select <Exit>
+  Select <Exit>
+  Select <Yes>
 make
 make install
 make modules_install
 
-The first time you use relayfs, you have to specify a mount point in you system:
+You must activate relayfs and specify a mount point. This is typically done in
+fstab such that it happens at boot time.
+
+If you have never used RelayFS before, these operation would do this for you :
 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
-
 reboot
 
+  Select the Linux 2.6.12-rc4-mm2-lttng-0.4 kernel in your boot loader.
+
 
 * Install the ltt-modules
 
@@ -92,10 +147,11 @@ cd /usr/src/lttng/lttng-modules-0.2
 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
+You need to load the ltt-control module to be able to control tracing from user
+space. This is done by issuing the command :
 modprobe ltt-control
 
-and you might also want to do this :
+You can automate at boot time loading the ltt-control module by :
 echo ltt-control >> /etc/modules
 
 

diff --git a/ltt/branches/poly/README b/ltt/branches/poly/README
index a052085a2cb8c1f0577d55e9f441088373f6ef48..ca6ac84a56f0ddaad0c972c0624eff880875faae 100644 (file)
--- a/ltt/branches/poly/README
+++ b/ltt/branches/poly/README
@@ -13,6 +13,7 @@ gtk 2 development libraries (libgtk2.0, libgtk2.0-dev)
 glib 2 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)
 
 To compile the source tree from a tarball, simply follow these steps :