summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-04-10 14:05:42 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-11 12:22:32 +0100
commitef14eb8f98182685d58e06317ade049fb8849df2 (patch)
tree8fbec479effe6068f1d351658869349cfa9f0ea4
parent7bc64bda4feb0742906912ebd45dc30d597153e9 (diff)
downloadpoky-ef14eb8f98182685d58e06317ade049fb8849df2.tar.gz
dev-manual: Edits to "Running User-Space Tools" section.
(From yocto-docs rev: bb3e5efe23d1bc890ad203e1c936937fb4fd8958) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-model.xml77
1 files changed, 42 insertions, 35 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 6e29c025f4..23e09c45fb 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1276,14 +1276,14 @@
1276 your development experience. 1276 your development experience.
1277 These tools are aids in developing and debugging applications and images. 1277 These tools are aids in developing and debugging applications and images.
1278 You can run these user-space tools from within the Eclipse IDE through the 1278 You can run these user-space tools from within the Eclipse IDE through the
1279 <filename>YoctoTools</filename> menu. 1279 "YoctoTools" menu.
1280 </para> 1280 </para>
1281 1281
1282 <para> 1282 <para>
1283 Once you pick a tool, you need to configure it for the remote target. 1283 Once you pick a tool, you need to configure it for the remote target.
1284 Every tool needs to have the connection configured. 1284 Every tool needs to have the connection configured.
1285 You must select an existing TCF-based RSE connection to the remote target. 1285 You must select an existing TCF-based RSE connection to the remote target.
1286 If one does not exist, click <filename>New</filename> to create one. 1286 If one does not exist, click "New" to create one.
1287 </para> 1287 </para>
1288 1288
1289 <para> 1289 <para>
@@ -1298,10 +1298,10 @@
1298 You must compile and install the <filename>oprofile-viewer</filename> from the source code 1298 You must compile and install the <filename>oprofile-viewer</filename> from the source code
1299 on your local host machine. 1299 on your local host machine.
1300 Furthermore, in order to convert the target's sample format data into a form that the 1300 Furthermore, in order to convert the target's sample format data into a form that the
1301 host can use, you must have <filename>oprofile</filename> version 0.9.4 or 1301 host can use, you must have OProfile version 0.9.4 or
1302 greater installed on the host.</para> 1302 greater installed on the host.</para>
1303 <para>You can locate both the viewer and server from 1303 <para>You can locate both the viewer and server from
1304 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink> 1304 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>.
1305 You can also find more information on setting up and 1305 You can also find more information on setting up and
1306 using this tool in the 1306 using this tool in the
1307 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>" 1307 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>"
@@ -1311,64 +1311,71 @@
1311 <listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis> 1311 <listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis>
1312 Selecting this tool transfers the remote target's 1312 Selecting this tool transfers the remote target's
1313 <filename>Lttng</filename> tracing data back to the local host machine 1313 <filename>Lttng</filename> tracing data back to the local host machine
1314 and uses the <filename>Lttng</filename> Eclipse plug-in to graphically 1314 and uses the Lttng Eclipse plug-in to graphically
1315 display the output. 1315 display the output.
1316 For information on how to use <filename>Lttng</filename> to trace an application, 1316 For information on how to use Lttng to trace an application,
1317 see <ulink url='http://lttng.org/documentation'></ulink>. 1317 see <ulink url='http://lttng.org/documentation'></ulink>
1318 and the
1319 "<ulink url='&YOCTO_DOCS_PROF_URL;#lttng-linux-trace-toolkit-next-generation'>LTTng (Linux Trace Toolkit, next generation)</ulink>"
1320 section, which is in the Yocto Project Profiling and Tracing Manual.
1318 <note>Do not use <filename>Lttng-user space (legacy)</filename> tool. 1321 <note>Do not use <filename>Lttng-user space (legacy)</filename> tool.
1319 This tool no longer has any upstream support.</note> 1322 This tool no longer has any upstream support.</note>
1320 </para> 1323 </para>
1321 <para>Before you use the <filename>Lttng2.0 ust trace import</filename> tool, 1324 <para>Before you use the <filename>Lttng2.0 ust trace import</filename> tool,
1322 you need to setup the <filename>Lttng</filename> Eclipse plug-in and create a 1325 you need to setup the Lttng Eclipse plug-in and create a
1323 <filename>Tracing</filename> project. 1326 Tracing project.
1324 Do the following: 1327 Do the following:
1325 <orderedlist> 1328 <orderedlist>
1326 <listitem><para>Select <filename>Window -> Open Perspective -> Other</filename> 1329 <listitem><para>Select "Open Perspective" from the
1327 and then select <filename>Tracing</filename>.</para></listitem> 1330 "Window" menu and then select "Tracing".</para></listitem>
1328 <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective 1331 <listitem><para>Click "OK" to change the Eclipse perspective
1329 into the <filename>Tracing</filename> perspective.</para></listitem> 1332 into the Tracing perspective.</para></listitem>
1330 <listitem><para>Create a new <filename>Tracing</filename> project by selecting 1333 <listitem><para>Create a new Tracing project by selecting
1331 <filename>File -> New -> Project</filename>.</para></listitem> 1334 "Project" from the "File -> New" menu.</para></listitem>
1332 <listitem><para>Choose <filename>Tracing -> Tracing Project</filename>. 1335 <listitem><para>Choose "Tracing Project" from the
1336 "Tracing" menu.
1333 </para></listitem> 1337 </para></listitem>
1334 <listitem><para>Generate your tracing data on the remote target. 1338 <listitem><para>Generate your tracing data on the remote target.
1335 </para></listitem> 1339 </para></listitem>
1336 <listitem><para>Click 1340 <listitem><para>Select "Lttng2.0 ust trace import" from
1337 <filename>Yocto Project Tools -> Lttng2.0 ust trace import</filename> 1341 the "Yocto Project Tools" menu to
1338 to start the data import process.</para></listitem> 1342 start the data import process.</para></listitem>
1339 <listitem><para>Specify your remote connection name.</para></listitem> 1343 <listitem><para>Specify your remote connection name.</para></listitem>
1340 <listitem><para>For the Ust directory path, specify the location of 1344 <listitem><para>For the Ust directory path, specify the location of
1341 your remote tracing data. 1345 your remote tracing data.
1342 Make sure the location ends with <filename>ust</filename> (e.g. 1346 Make sure the location ends with <filename>ust</filename> (e.g.
1343 <filename>/usr/mysession/ust</filename>.</para></listitem> 1347 <filename>/usr/mysession/ust</filename>).</para></listitem>
1344 <listitem><para>Click <filename>OK</filename> to complete the import process. 1348 <listitem><para>Click "OK" to complete the import process.
1345 The data is now in the local tracing project you created.</para></listitem> 1349 The data is now in the local tracing project you created.</para></listitem>
1346 <listitem><para>Right click on the data and then use the menu to 1350 <listitem><para>Right click on the data and then use the menu to
1347 <filename>Select Trace Type... -> Common Trace Format -> Generic CTF Trace</filename> 1351 Select "Generic CTF Trace" from the
1348 to map the tracing type.</para></listitem> 1352 "Trace Type... -> Common Trace Format" menu to map
1349 <listitem><para>Right click the mouse and select <filename>Open</filename> 1353 the tracing type.</para></listitem>
1350 to bring up the Eclipse <filename>Lttng</filename> Trace Viewer so you 1354 <listitem><para>Right click the mouse and select "Open"
1355 to bring up the Eclipse Lttng Trace Viewer so you
1351 view the tracing data.</para></listitem> 1356 view the tracing data.</para></listitem>
1352 </orderedlist></para></listitem> 1357 </orderedlist></para></listitem>
1353 <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs 1358 <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs
1354 <filename>powertop</filename> on the remote target machine and displays the results in a 1359 PowerTOP on the remote target machine and displays the results in a
1355 new view called <filename>powertop</filename>.</para> 1360 new view called PowerTOP.</para>
1356 <para><filename>Time to gather data(sec):</filename> is the time passed in seconds before data 1361 <para>The "Time to gather data(sec):" field is the time passed in seconds before data
1357 is gathered from the remote target for analysis.</para> 1362 is gathered from the remote target for analysis.</para>
1358 <para><filename>show pids in wakeups list:</filename> corresponds to the 1363 <para>The "show pids in wakeups list:" field corresponds to the
1359 <filename>-p</filename> argument 1364 <filename>-p</filename> argument
1360 passed to <filename>powertop</filename>.</para></listitem> 1365 passed to <filename>PowerTOP</filename>.</para></listitem>
1361 <listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis> 1366 <listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis>
1362 <filename>latencytop</filename> identifies system latency, while 1367 LatencyTOP identifies system latency, while
1363 <filename>perf</filename> monitors the system's 1368 Perf monitors the system's performance counter registers.
1364 performance counter registers.
1365 Selecting either of these tools causes an RSE terminal view to appear 1369 Selecting either of these tools causes an RSE terminal view to appear
1366 from which you can run the tools. 1370 from which you can run the tools.
1367 Both tools refresh the entire screen to display results while they run. 1371 Both tools refresh the entire screen to display results while they run.
1368 For more informationi on setting up and using <filename>perf</filename>, 1372 For more information on setting up and using <filename>perf</filename>,
1369 see the 1373 see the
1370 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>" 1374 "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>"
1371 section in the Yocto Project Profiling and Tracing Manual. 1375 section in the Yocto Project Profiling and Tracing Manual.
1376 For information on LatencyTOP, see the
1377 <ulink url='https://latencytop.org/'>LatencyTOP</ulink>
1378 website.
1372 </para></listitem> 1379 </para></listitem>
1373 </itemizedlist> 1380 </itemizedlist>
1374 </para> 1381 </para>