X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=trunk%2Flttv%2FQUICKSTART.html;h=caacc2c2de32440ed68f60d9518f7e97b54e3b88;hb=305fd815e6e9831f9fab2c36d36f962df929f9b7;hp=030d7e93c777062073587f2ab839c74407090f7c;hpb=38b04cd7c383238a8ddb371cadda9e77e33bb7bf;p=lttv.git

diff --git a/trunk/lttv/QUICKSTART.html b/trunk/lttv/QUICKSTART.html
index 030d7e93..caacc2c2 100644
--- a/trunk/lttv/QUICKSTART.html
+++ b/trunk/lttv/QUICKSTART.html
@@ -16,14 +16,32 @@ Last update : January 21st, 2009<br>
 
 <li><a href="#intro" name="TOCintro">Introduction</a></li>
 <li><a href="#section1" name="TOCsection1">Installing LTTng and LTTV from
-<ul>
-<li><a href="#userspacetracing" name="TOCuserspacetracing">Userspace Tracing</ul>
 sources</a></li>
+<ul>
+<li><a href="#prerequisites" name="TOCprerequisites">Prerequisistes</li>
+<li><a href="#getlttng" name="TOCgetlttng">Getting the LTTng packages</li>
+<li><a href="#getlttngsrc" name="TOCgetlttngsrc">Getting the LTTng kernel sources</li>
+<li><a href="#installlttng" name="TOCinstalllttng">Installing a LTTng kernel</li>
+<li><a href="#editconfig" name="TOCeditconfig">Editing the system wide
+configuration</a>
+<li><a href="#getlttctl" name="TOCgetlttctl">Getting and installing the
+ltt-control package</li>
+<li><a href="#userspacetracing" name="TOCuserspacetracing">Userspace Tracing</li>
+<li><a href="#getlttv" name="TOCgetlttv">Getting and installing the LTTV package</ul>
 <li><a href="#section2" name="TOCsection2">Using LTTng and LTTV</a></li>
 <li><a href="#section3" name="TOCsection3">Adding kernel and user-space
-tracepoints</a></li>
+instrumentation</a>
+<ul>
+<li><a href="#kerneltp" name="TOCkerneltp">Adding kernel instrumentation</a></li>
+<li><a href="#usertp" name="TOCusertp">Adding userspace instrumentation</a></li>
+</ul>
 <li><a href="#section4" name="TOCsection4">Creating Debian and RPM packages
-from LTTV</a>
+from LTTV</a></li>
+<ul>
+<li><a href="#pkgdebian" name="TOCpkgdebian">Create custom LTTV Debian
+<li><a href="#pkglttng" name="TOCpkglttng">Create custom LTTng packages</a></li>
+
+</ul>
 
 </ul>
 
@@ -50,7 +68,7 @@ The lttng patch is necessary to have the tracing hooks in the kernel.
 <br>
 <br>
 Supported architectures : 
-<br>
+br>
 LTTng :<br>
 <li> x86 32/64 bits
 <li> PowerPC 32 and 64 bits
@@ -71,7 +89,7 @@ the LTTng traces and the LTTV analysis tool.
 <h2><a href="#TOCsection1" name="section1">Installation from sources</a></h2>
 <p>
 
-<li>Prerequisites</li>
+<h3><a href="#TOCprerequisites" name="prerequisites">Prerequisites</a></h3>
 <ul>
 <p>
 Tools needed to follow the package download steps :
@@ -132,7 +150,7 @@ href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibilit
 versions compatibility</a>.
 
 
-<li>Getting the LTTng packages</li>
+<h3><a href="#TOCgetlttng" name="getlttng">Getting the LTTng packages</a></h3>
 
 <PRE>
 su -
@@ -144,7 +162,7 @@ bzip2 -cd patch-2.6.X-lttng-0.x.xx.tar.bz2 | tar xvof -
 </PRE>
 
 
-<li>Getting LTTng kernel sources</li>
+<h3><a href="#TOCgetlttngsrc" name="getlttngsrc">Getting LTTng kernel sources</a></h3>
 
 <PRE>
 su -
@@ -160,7 +178,7 @@ mv linux-2.6.X linux-2.6.X-lttng-0.x.xx
 </PRE>
 
 
-<li>Installing a LTTng kernel</li>
+<h3><a href="#TOCinstalllttng" name="installlttng">Installing a LTTng kernel</a></h3>
 
 <PRE>
 su -
@@ -217,7 +235,8 @@ Select the Linux 2.6.X-lttng-0.x.xx kernel in your boot loader.
 --
 </PRE>
 
-<li>Editing the system wide configuration</li>
+<h3><a href="#TOCeditconfig" name="editconfig">Editing the system wide
+configuration</a></h3>
 
 <p>
 You must activate debugfs and specify a mount point. This is typically done in
@@ -292,7 +311,9 @@ echo trap-trace >> /etc/modules
 #echo lockdep-trace >> /etc/modules
 </PRE>
 
-<li>Getting and installing the ltt-control package (on the traced machine)</li>
+
+<h3><a href="#TOCgetlttctl" name="getlttctl">Getting and installing the
+ltt-control package (on the traced machine)</a></h3>
 <p>
 (note : the ltt-control package contains lttd and lttctl. Although it has the
 same name as the ltt-control kernel module, they are *not* the same thing.)
@@ -326,8 +347,9 @@ channel : userspace
 event name : event
 </PRE>
 
-<li>Getting and installing the LTTV package (on the visualisation machine, same
-or different from the visualisation machine)</li>
+<h3><a href="#TOCgetlttv" name="getlttv">Getting and installing the LTTV package
+(on the visualisation machine, same
+or different from the visualisation machine)</a></h3>
 
 <PRE>
 su -
@@ -449,14 +471,24 @@ lttctl -D -w /tmp/trace3 trace3
 markers</a></h2>
 <p>
 
+<h3><a href="#TOCkerneltp" name="kerneltp">Adding kernel
+instrumentation</a></h3>
+
 <p>
-See Documentation/markers.txt and Documentation/tracepoints.txt in your kernel
+See <a
+href="http://git.kernel.org/?p=linux/kernel/git/compudj/linux-2.6-lttng.git;a=blob;f=Documentation/markers.txt">Documentation/markers.txt</a>
+and <a
+href="http://git.kernel.org/?p=linux/kernel/git/compudj/linux-2.6-lttng.git;a=blob;f=Documentation/tracepoints.txt">Documentation/tracepoints.txt</a> in your kernel
 tree.
+<p>
+Also see <a
+href="http://git.kernel.org/?p=linux/kernel/git/compudj/linux-2.6-lttng.git;a=tree;f=ltt/probes">ltt/probes/</a>
+for LTTng probe examples.
 
-<li>Add new events to userspace programs with
-<a href="http://ltt.polymtl.ca/packages/">userspace markers packages</a></li>
+<h3><a href="#TOCusertp" name="usertp">Adding userspace instrumentation</a></h3>
 
-<p>
+Add new events to userspace programs with
+<a href="http://ltt.polymtl.ca/packages/">userspace markers packages</a>.
 Get the latest markers-userspace-*.tar.bz2 and see the Makefile and examples. It
 allows inserting markers in executables and libraries, currently only on x86_32
 and x86_64.
@@ -467,7 +499,7 @@ href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-user
 Note that a new design document for a 3rd generation of tracepoint/marker-based
 userspace tracing is available at <a
 href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/ust.html">LTTng User-space Tracing
-Design"</a>. This new infrastructure is not yet implemented.
+Design</a>. This new infrastructure is not yet implemented.
 
 <p>
 The easy quick-and-dirty way to perform userspace tracing is currently to write
@@ -480,7 +512,7 @@ installation for sources section of this document.
 <h2><a href="#TOCsection4" name="section4">Creating Debian or RPM packages</a></h2>
 <p>
 
-<li>Create custom LTTV Debian packages</li>
+<h3><a href="#TOCpkgdebian" name="pkgdebian">Create custom LTTV Debian packages</a></h3>
 
 <PRE>
 Use : dpkg-buildpackage -rfakeroot
@@ -488,7 +520,7 @@ Use : dpkg-buildpackage -rfakeroot
 <p>
 You should then have your LTTV .deb files created for your architecture.
 
-<li>Create custom LTTng packages</li>
+<h3><a href="#TOCpkglttng" name="pkglttng">Create custom LTTng packages</a></h3>
 <p>
 For building LTTng Debian packages :
 get the build tree with patches applies as explained in section 2.