trace/traceanalyser/com.nokia.s60tools.traceanalyser.help/html/gettingstarted/traceanalyser_basic_walkthrough.htm
author Matti Laitinen <matti.t.laitinen@nokia.com>
Wed, 23 Jun 2010 13:57:56 +0300
changeset 9 14dc2103a631
permissions -rw-r--r--
TraceAnalyser 1.0.5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
9
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     2
<html>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     3
<head>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     4
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     5
<title>TraceAnalyser basic walk-through</title>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     6
<link href="../../book.css" type="text/css" rel="stylesheet"></head>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     7
<body><h2>TraceAnalyser basic walk-through</h2> <h5>Before you start</h5><p>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     8
Setting up TraceAnalyser requires the following tracing tools: </p><ul>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
     9
<li><b>In Carbide.c++:</b> TraceBuilder and TraceViewer tools, accessible
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    10
from the <b>Carbide</b> menu. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    11
<li><b>In the device:</b> (Optional) The TraceSwitch tool that listens to
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    12
the incoming traces. For more information on how to obtain it, see the <a
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    13
href="../release_notes.htm#requirements">Release Note</a><?Pub Caret1>. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    14
</ul><p>The following steps are needed for using this tool: </p><ol>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    15
<li>Open or create a project in Carbide.c++. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    16
<li>To add OST traces to the source code, start the TraceBuilder tool from <b>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    17
Carbide > TraceBuilder</b>. <p> For more instructions, see the topic <i>Adding
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    18
traces to the source code</i> in TraceBuilder Help. </p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    19
<li>Set your project's include paths and compile the application. For instructions,
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    20
see <i>Setting project include paths and compiling</i> in TraceBuilder Help. <p><b>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    21
Note:</b> Compilation uses TraceCompiler that generates the needed headers.
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    22
After compilation, you should have two files: </p><ul>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    23
<li>a SIS file of your tool that you can now install into the device. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    24
<li>an XML format dictionary file that is needed for activating and decoding
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    25
traces in TraceViewer. It is generated into the following directory: <i>[SDK
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    26
root]\epoc32\include\internal\symbiantraces\dictionary</i>. </li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    27
</ul></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    28
<li>In TraceViewer, also define the settings for connecting your PC to the
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    29
device. The options are USB or eXtended Trace Interface (XTI). <p>See <i>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    30
Setting TraceViewer preferences</i> in TraceViewer Help. </p><p><b>Tip:</b> If
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    31
you have TraceSwitch enabled in the device, the USB connection is supported
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    32
by default and you only need to plug in the device to start receiving traces. 
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    33
</p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    34
<li>To activate and decode traces, start the TraceViewer tool from <b>Carbide
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    35
> TraceViewer</b>, and activate the dictionary file there. <p>For instructions,
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    36
see <i>Trace activation </i> in TraceViewer Help. </p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    37
<li>In TraceAnalyser, create the rules for issues you want to monitor: timings
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    38
or parameters. <p>See example scenarios in <i>TraceAnalyser overview</i> and
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    39
step-by-step instructions in <a href="../tasks/creating_rules.htm">Creating
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    40
tracing rules</a>. </p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    41
<li>Transfer your application's SIS file to the device and run it. <p>If some
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    42
tracing rules fail during execution, they are listed on the TraceAnalyser's <b>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    43
Fail Log</b> tab.</p></li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    44
<li>To analyse the failed rule in more detail, double-click it to view it
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    45
in the TraceViewer application. TraceViewer will show the codeline that caused
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    46
the failure.</li>
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    47
</ol><div id="footer">Copyright &copy; 2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. 
14dc2103a631 TraceAnalyser 1.0.5
Matti Laitinen <matti.t.laitinen@nokia.com>
parents:
diff changeset
    48
License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.</div> </body></html>