update manual (links)
[lttv.git] / LTTngManual.html
index e0f97eebab78c1c4c4b80bcbee865048e7515d1b..ca74b5079e5ec7dcf81990a8df8b8a8d8d9df31e 100644 (file)
@@ -8,7 +8,7 @@
 <h1>Linux Trace Toolkit Next Generation Manual</h1>
 
 Author : Mathieu Desnoyers, September 2005<br>
 <h1>Linux Trace Toolkit Next Generation Manual</h1>
 
 Author : Mathieu Desnoyers, September 2005<br>
-Last update : January 21st, 2009<br>
+Last update : January 30, 2010<br>
 (originally known as the LTTng QUICKSTART guide)
 
 <h2>Table of Contents</h2>
 (originally known as the LTTng QUICKSTART guide)
 
 <h2>Table of Contents</h2>
@@ -16,6 +16,8 @@ Last update : January 21st, 2009<br>
 <ul>
 <li><a href="#intro" name="TOCintro">Introduction</a></li>
 <ul>
 <ul>
 <li><a href="#intro" name="TOCintro">Introduction</a></li>
 <ul>
+<li><a href="#licenses" name="TOClicenses">Licenses</a></li>
+<ul>
 <li><a href="#arch" name="TOCarch">Supported architectures</a></li>
 </ul>
 
 <li><a href="#arch" name="TOCarch">Supported architectures</a></li>
 </ul>
 
@@ -77,7 +79,7 @@ Linux Trace Toolkit Viewer.
 To see the list of compatibilities between LTTng, ltt-control, LTTV, please
 refer to :
 <a
 To see the list of compatibilities between LTTng, ltt-control, LTTV, please
 refer to :
 <a
-href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibility.html">LTTng+LTTV versions compatibility</a>
+href="http://lttng.org/cgi-bin/gitweb.cgi?p=lttv.git;a=blob_plain;f=doc/developer/lttng-lttv-compatibility.html;hb=HEAD">LTTng+LTTV versions compatibility</a>
 
 The ongoing work had the Linux Kernel Markers integrated in the mainline Linux
 kernel since Linux 2.6.24 and the Tracepoints since 2.6.28. In its current
 
 The ongoing work had the Linux Kernel Markers integrated in the mainline Linux
 kernel since Linux 2.6.24 and the Tracepoints since 2.6.28. In its current
@@ -87,8 +89,7 @@ kernel.
 
 <br>
 <br>
 
 <br>
 <br>
-<h3><a href="#TOClicense" name="license">Licenses</a></h3>
-<br>
+<h3><a href="#TOClicenses" name="licenses">Licenses</a></h3>
 <p>
 LTTng, UST and LTTV are developed by an open community. LTTng is released under
 a dual Gnu LGPLv2.1/GPLv2 license, except for very few kernel-specific files
 <p>
 LTTng, UST and LTTV are developed by an open community. LTTng is released under
 a dual Gnu LGPLv2.1/GPLv2 license, except for very few kernel-specific files
@@ -97,6 +98,9 @@ which are derived work from the Linux kernel.
 LTTV is available under the Gnu GPLv2. The low-level LTTV trace reading library
 is released under Gnu LGPLv2.1.
 <p>
 LTTV is available under the Gnu GPLv2. The low-level LTTV trace reading library
 is released under Gnu LGPLv2.1.
 <p>
+The Eclipse LTTng trace analysis tool is released under the EPL and uses the
+LTTV trace reading library (LGPLv2.1).
+<p>
 The UST (Userspace Tracing) and the Userspace RCU libraries are released under
 the LGPLv2.1 license, which allows linking with non-GPL (BSD, proprietary...)
 applications. The associated headers are released under MIT-style/BSD-style
 The UST (Userspace Tracing) and the Userspace RCU libraries are released under
 the LGPLv2.1 license, which allows linking with non-GPL (BSD, proprietary...)
 applications. The associated headers are released under MIT-style/BSD-style
@@ -104,10 +108,7 @@ licenses.
 <p>
 Please refer to each particular file licensing for details.
 
 <p>
 Please refer to each particular file licensing for details.
 
-<br>
-<br>
 <h3><a href="#TOCarch" name="arch">Supported architectures</a></h3>
 <h3><a href="#TOCarch" name="arch">Supported architectures</a></h3>
-<br>
 LTTng :<br>
 <br>
 <li> x86 32/64 bits
 LTTng :<br>
 <br>
 <li> x86 32/64 bits
@@ -173,7 +174,7 @@ gtk 2.4 or better development libraries
   (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.
   (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
+glib 2.16 or better development libraries
   (Debian : libglib2.0-0, libglib2.0-dev)
   (Fedora : glib2, glib2-devel)
 libpopt development libraries
   (Debian : libglib2.0-0, libglib2.0-dev)
   (Fedora : glib2, glib2-devel)
 libpopt development libraries
@@ -193,8 +194,7 @@ libc6 development librairies
 <p>
 See the list of compatibilities between LTTng, ltt-control and LTTV at :
 <a
 <p>
 See the list of compatibilities between LTTng, ltt-control and LTTV at :
 <a
-href="http://ltt.polymtl.ca/svn/trunk/lttv/doc/developer/lttng-lttv-compatibility.html">LTTng+LTTV
-versions compatibility</a>.
+href="http://lttng.org/cgi-bin/gitweb.cgi?p=lttv.git;a=blob_plain;f=doc/developer/lttng-lttv-compatibility.html;hb=HEAD">LTTng+LTTV versions compatibility</a>.
 
 
 <h3><a href="#TOCgetlttng" name="getlttng">Getting the LTTng packages</a></h3>
 
 
 <h3><a href="#TOCgetlttng" name="getlttng">Getting the LTTng packages</a></h3>
@@ -231,7 +231,7 @@ mv linux-2.6.X linux-2.6.X-lttng-0.x.xx
 su -
 cd /usr/src/linux-2.6.X-lttng-0.x.xx
 make menuconfig (or make xconfig or make config)
 su -
 cd /usr/src/linux-2.6.X-lttng-0.x.xx
 make menuconfig (or make xconfig or make config)
-    Select the < Help > button if you are not familiar with kernel
+    Select the &lt; Help &gt; 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.
     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.
@@ -242,21 +242,21 @@ make menuconfig (or make xconfig or make config)
     [*] Activate markers
     [*] Activate userspace markers ABI (experimental, optional)
     [*] Immediate value optimization (optional)
     [*] Activate markers
     [*] Activate userspace markers ABI (experimental, optional)
     [*] Immediate value optimization (optional)
-    [*] Linux Trace Toolkit Next Generation (LTTng) --->
-    <M> or <*> Compile lttng tracing probes
-    <M> or <*> Linux Trace Toolkit High-speed Lockless Data Relay
-    <M> or <*> Linux Trace Toolkit Lock-Protected Data Relay
-    <M> or <*> Linux Trace Toolkit Serializer
-    <M> or <*>   Linux Trace Toolkit Marker Control
-    <M> or <*>     Linux Trace Toolkit Tracer
+    [*] Linux Trace Toolkit Next Generation (LTTng) ---&gt;
+    &lt;M&gt; or &lt;*&gt; Compile lttng tracing probes
+    &lt;M&gt; or &lt;*&gt; Linux Trace Toolkit High-speed Lockless Data Relay
+    &lt;M&gt; or &lt;*&gt; Linux Trace Toolkit Lock-Protected Data Relay
+    &lt;M&gt; or &lt;*&gt; Linux Trace Toolkit Serializer
+    &lt;M&gt; or &lt;*&gt;   Linux Trace Toolkit Marker Control
+    &lt;M&gt; or &lt;*&gt;     Linux Trace Toolkit Tracer
     [*] Align Linux Trace Toolkit Traces
     [*] Align Linux Trace Toolkit Traces
-    <M> or <*> Support logging events from userspace
+    &lt;M&gt; or &lt;*&gt; Support logging events from userspace
     [*] Support trace extraction from crash dump
     [*] Support trace extraction from crash dump
-    <M> or <*> Linux Trace Toolkit Trace Controller
-    <M> or <*> Linux Trace Toolkit State Dump
-  Select <Exit>
-  Select <Exit>
-  Select <Yes>
+    &lt;M&gt; or &lt;*&gt; Linux Trace Toolkit Trace Controller
+    &lt;M&gt; or &lt;*&gt; Linux Trace Toolkit State Dump
+  Select &lt;Exit&gt;
+  Select &lt;Exit&gt;
+  Select &lt;Yes&gt;
 make
 make modules_install
 (if necessary, create a initrd with mkinitrd or your preferate alternative)
 make
 make modules_install
 (if necessary, create a initrd with mkinitrd or your preferate alternative)
@@ -384,12 +384,12 @@ ldconfig
 
 <PRE>
 Make sure you selected the kernel menuconfig option :
 
 <PRE>
 Make sure you selected the kernel menuconfig option :
-    <M> or <*> Support logging events from userspace
+    &lt;M&gt; or &lt;*&gt; Support logging events from userspace
 And that the ltt-userspace-event kernel module is loaded if selected as a
 module.
 
 Simple userspace tracing is available through
 And that the ltt-userspace-event kernel module is loaded if selected as a
 module.
 
 Simple userspace tracing is available through
-echo "some text to record" > /mnt/debugfs/ltt/write_event
+echo "some text to record" &gt; /mnt/debugfs/ltt/write_event
 
 It will appear in the trace under event :
 channel : userspace
 
 It will appear in the trace under event :
 channel : userspace
@@ -550,10 +550,8 @@ See <a
 href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-userspace-0.5.tar.bz2</a> or more recent.
 
 <p>
 href="http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2">markers-userspace-0.5.tar.bz2</a> or more recent.
 
 <p>
-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.
+Note that tracepoint/marker-based userspace tracing is available at <a
+href="http://lttng.org/ust/">LTTng User-space Tracer (UST)</a>.
 
 <p>
 The easy quick-and-dirty way to perform userspace tracing is currently to write
 
 <p>
 The easy quick-and-dirty way to perform userspace tracing is currently to write
This page took 0.02569 seconds and 4 git commands to generate.