update features

[lttv.git] / trunk / lttv / QUICKSTART.html

diff --git a/trunk/lttv/QUICKSTART.html b/trunk/lttv/QUICKSTART.html
index daef794ced08652e46c3190369d27599ab89c510..74e9862058e4c6faceede2b8df991765cfe09284 100644 (file)
--- a/trunk/lttv/QUICKSTART.html
+++ b/trunk/lttv/QUICKSTART.html
@@ -18,21 +18,30 @@ Last update : January 21st, 2009<br>
 <li><a href="#section1" name="TOCsection1">Installing LTTng and LTTV from
 sources</a></li>
 <ul>
-<li><a href="#prerequisites" name="TOCprerequisites">Prerequisistes</ul>
-<li><a href="#getlttng" name="TOCgetlttng">Getting the LTTng packages</ul>
-<li><a href="#getlttngsrc" name="TOCgetlttngsrc">Getting the LTTng kernel sources</ul>
-<li><a href="#installlttng" name="TOCinstalllttng">Installing a LTTng kernel</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</ul>
-<li><a href="#userspacetracing" name="TOCuserspacetracing">Userspace Tracing</ul>
+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>
 
@@ -462,9 +471,21 @@ 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.
+
+<h3><a href="#TOCusertp" name="usertp">Adding userspace instrumentation</a></h3>
 
 <li>Add new events to userspace programs with
 <a href="http://ltt.polymtl.ca/packages/">userspace markers packages</a></li>
@@ -480,7 +501,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
@@ -493,7 +514,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
@@ -501,7 +522,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.