From 1ca2e833d9f96299d0ba93d3e2386c10710a0c0a Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 10 Apr 2013 14:05:42 -0700 Subject: dev-manual: Edits to "Running User-Space Tools" section. (From yocto-docs rev: bb3e5efe23d1bc890ad203e1c936937fb4fd8958) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-model.xml | 77 +++++++++++++++------------ 1 file changed, 42 insertions(+), 35 deletions(-) (limited to 'documentation') 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 @@ your development experience. These tools are aids in developing and debugging applications and images. You can run these user-space tools from within the Eclipse IDE through the - YoctoTools menu. + "YoctoTools" menu. Once you pick a tool, you need to configure it for the remote target. Every tool needs to have the connection configured. You must select an existing TCF-based RSE connection to the remote target. - If one does not exist, click New to create one. + If one does not exist, click "New" to create one. @@ -1298,10 +1298,10 @@ You must compile and install the oprofile-viewer from the source code on your local host machine. Furthermore, in order to convert the target's sample format data into a form that the - host can use, you must have oprofile version 0.9.4 or + host can use, you must have OProfile version 0.9.4 or greater installed on the host. You can locate both the viewer and server from - + . You can also find more information on setting up and using this tool in the "OProfile" @@ -1311,64 +1311,71 @@ Lttng2.0 ust trace import: Selecting this tool transfers the remote target's Lttng tracing data back to the local host machine - and uses the Lttng Eclipse plug-in to graphically + and uses the Lttng Eclipse plug-in to graphically display the output. - For information on how to use Lttng to trace an application, - see . + For information on how to use Lttng to trace an application, + see + and the + "LTTng (Linux Trace Toolkit, next generation)" + section, which is in the Yocto Project Profiling and Tracing Manual. Do not use Lttng-user space (legacy) tool. This tool no longer has any upstream support. Before you use the Lttng2.0 ust trace import tool, - you need to setup the Lttng Eclipse plug-in and create a - Tracing project. + you need to setup the Lttng Eclipse plug-in and create a + Tracing project. Do the following: - Select Window -> Open Perspective -> Other - and then select Tracing. - Click OK to change the Eclipse perspective - into the Tracing perspective. - Create a new Tracing project by selecting - File -> New -> Project. - Choose Tracing -> Tracing Project. + Select "Open Perspective" from the + "Window" menu and then select "Tracing". + Click "OK" to change the Eclipse perspective + into the Tracing perspective. + Create a new Tracing project by selecting + "Project" from the "File -> New" menu. + Choose "Tracing Project" from the + "Tracing" menu. Generate your tracing data on the remote target. - Click - Yocto Project Tools -> Lttng2.0 ust trace import - to start the data import process. + Select "Lttng2.0 ust trace import" from + the "Yocto Project Tools" menu to + start the data import process. Specify your remote connection name. For the Ust directory path, specify the location of your remote tracing data. Make sure the location ends with ust (e.g. - /usr/mysession/ust. - Click OK to complete the import process. + /usr/mysession/ust). + Click "OK" to complete the import process. The data is now in the local tracing project you created. Right click on the data and then use the menu to - Select Trace Type... -> Common Trace Format -> Generic CTF Trace - to map the tracing type. - Right click the mouse and select Open - to bring up the Eclipse Lttng Trace Viewer so you + Select "Generic CTF Trace" from the + "Trace Type... -> Common Trace Format" menu to map + the tracing type. + Right click the mouse and select "Open" + to bring up the Eclipse Lttng Trace Viewer so you view the tracing data. PowerTOP: Selecting this tool runs - powertop on the remote target machine and displays the results in a - new view called powertop. - Time to gather data(sec): is the time passed in seconds before data + PowerTOP on the remote target machine and displays the results in a + new view called PowerTOP. + The "Time to gather data(sec):" field is the time passed in seconds before data is gathered from the remote target for analysis. - show pids in wakeups list: corresponds to the + The "show pids in wakeups list:" field corresponds to the -p argument - passed to powertop. - LatencyTOP and Perf: - latencytop identifies system latency, while - perf monitors the system's - performance counter registers. + passed to PowerTOP. + LatencyTOP and Perf: + LatencyTOP identifies system latency, while + Perf monitors the system's performance counter registers. Selecting either of these tools causes an RSE terminal view to appear from which you can run the tools. Both tools refresh the entire screen to display results while they run. - For more informationi on setting up and using perf, + For more information on setting up and using perf, see the "perf" section in the Yocto Project Profiling and Tracing Manual. + For information on LatencyTOP, see the + LatencyTOP + website. -- cgit v1.2.3-54-g00ecf