sdk-manual: Created new Mars Eclipse appendix

Fixes [YOCTO #7546] First draft of the new appendix supporting the Mars version of eclipse. New appendix file created and entry made to the sdk-manual.xml file to include that new appendix file into the main book. (From yocto-docs rev: 2fb79c29bcbb5c0801f67d4c245c07c3aa9d2ca2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> sdk-manual: WIP on appendix C Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
author: Scott Rifenbark <srifenbark@gmail.com> 2016-08-12 10:20:16 -0700
committer: Richard Purdie <richard.purdie@linuxfoundation.org> 2016-08-25 23:09:27 +0100
commit: 4d5dc4a8908c4f67268f2058e1ea6d76f72ca0ef (patch)
tree: 3489d42ca80e9fdb6272d09341c2069b01188ac5 /documentation/sdk-manual/sdk-using.xml
parent: a3f519e19399e239cf1efde523af426f6a519d4f (diff)
download: poky-4d5dc4a8908c4f67268f2058e1ea6d76f72ca0ef.tar.gz
1 files changed, 14 insertions, 138 deletions
diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml
index 9354ace3b9..f8e2f005bd 100644
--- a/documentation/sdk-manual/sdk-using.xml
+++ b/documentation/sdk-manual/sdk-using.xml
@@ -533,10 +533,10 @@
                    </para></listitem>
                <listitem><para><emphasis>Test and debug the application</emphasis>:
                    Once your application is deployed, you need to test it.
-                    Within the Eclipse IDE, you can use the debugging environment along with the
+                    Within the Eclipse IDE, you can use the debugging
-                    set of installed user-space tools to debug your application.
+                    environment along with supported performance enhancing
-                    Of course, the same user-space tools are available separately if you choose
+                    <ulink url='http://www.eclipse.org/linuxtools/'>tools</ulink>.
-                    not to use the Eclipse IDE.</para></listitem>
+                    </para></listitem>
           </orderedlist>
        </para>
    </section>
@@ -565,9 +565,11 @@
            execution of your output into a QEMU emulation session as well as
            actual target hardware.
            You can also perform cross-debugging and profiling.
-            The environment also supports a suite of tools that allows you
+            The environment also supports performance enhancing
-            to perform remote profiling, tracing, collection of power data,
+            <ulink url='http://www.eclipse.org/linuxtools/'>tools</ulink> that
-            collection of latency data, and collection of performance data.
+            allow you to perform remote profiling, tracing, collection of
+            power data, collection of latency data, and collection of
+            performance data.
        </para>
        <para>
@@ -1317,144 +1319,18 @@
            </para>
        </section>
-        <section id='running-user-space-tools'>
+        <section id='running-performance-tools'>
-            <title>Running User-Space Tools</title>
+            <title>Running Performance Tools</title>
            <para>
                As mentioned earlier in the manual, several tools exist that
                enhance 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
+                You can run these tools from within the Eclipse
                IDE through the "YoctoProjectTools" menu.
-            </para>
+                For more information on these tools, see
+                <ulink url='http://www.eclipse.org/linuxtools/'>http://www.eclipse.org/linuxtools/</ulink>.
-            <para>
-                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.
-            </para>
-            <para>
-                Here are some specifics about the remote tools:
-                <itemizedlist>
-                    <listitem><para><emphasis><filename>Lttng2.0 trace import</filename>:</emphasis>
-                        Selecting this tool transfers the remote target's
-                        <filename>Lttng</filename> tracing data back to the
-                        local host machine and uses the Lttng Eclipse plug-in
-                        to graphically display the output.
-                        For information on how to use Lttng to trace an
-                        application,
-                        see <ulink url='http://lttng.org/documentation'></ulink>
-                        and the
-                        "<ulink url='&YOCTO_DOCS_PROF_URL;#lttng-linux-trace-toolkit-next-generation'>LTTng (Linux Trace Toolkit, next generation)</ulink>"
-                        section, which is in the Yocto Project Profiling and
-                        Tracing Manual.
-                        <note>Do not use
-                            <filename>Lttng-user space (legacy)</filename> tool.
-                            This tool no longer has any upstream support.</note>
-                        </para>
-                        <para>Before you use the
-                        <filename>Lttng2.0 trace import</filename> tool,
-                        you need to setup the Lttng Eclipse plug-in and create a
-                        Tracing project.
-                        Do the following:
-                        <orderedlist>
-                            <listitem><para>Select "Open Perspective" from the
-                                "Window" menu and then select "Other..." to
-                                bring up a menu of other perspectives.
-                                Choose "Tracing".
-                                </para></listitem>
-                            <listitem><para>Click "OK" to change the Eclipse
-                                perspective into the Tracing perspective.
-                                </para></listitem>
-                            <listitem><para>Create a new Tracing project by
-                                selecting "Project" from the "File -> New" menu.
-                                </para></listitem>
-                            <listitem><para>Choose "Tracing Project" from the
-                                "Tracing" menu and click "Next".
-                                </para></listitem>
-                            <listitem><para>Provide a name for your tracing
-                                project and click "Finish".
-                                </para></listitem>
-                            <listitem><para>Generate your tracing data on the
-                                remote target.</para></listitem>
-                            <listitem><para>Select "Lttng2.0 trace import"
-                                from the "Yocto Project Tools" menu to
-                                start the data import process.</para></listitem>
-                            <listitem><para>Specify your remote connection name.
-                                </para></listitem>
-                            <listitem><para>For the Ust directory path, specify
-                                the location of your remote tracing data.
-                                Make sure the location ends with
-                                <filename>ust</filename> (e.g.
-                                <filename>/usr/mysession/ust</filename>).
-                                </para></listitem>
-                            <listitem><para>Click "OK" to complete the import
-                                process.
-                                The data is now in the local tracing project
-                                you created.</para></listitem>
-                            <listitem><para>Right click on the data and then use
-                                the menu to Select "Generic CTF Trace" from the
-                                "Trace Type... -> Common Trace Format" menu to
-                                map the tracing type.</para></listitem>
-                            <listitem><para>Right click the mouse and select
-                                "Open" to bring up the Eclipse Lttng Trace
-                                Viewer so you view the tracing data.
-                                </para></listitem>
-                        </orderedlist></para></listitem>
-                    <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis>
-                        Selecting this tool runs PowerTOP on the remote target
-                        machine and displays the results in a new view called
-                        PowerTOP.</para>
-                        <para>The "Time to gather data(sec):" field is the time
-                        passed in seconds before data is gathered from the
-                        remote target for analysis.</para>
-                        <para>The "show pids in wakeups list:" field corresponds
-                        to the <filename>-p</filename> argument passed to
-                        <filename>PowerTOP</filename>.</para></listitem>
-                    <listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis>
-                        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 information on setting up and using
-                        <filename>perf</filename>, see the
-                        "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>"
-                        section in the Yocto Project Profiling and Tracing
-                        Manual.
-                        </para></listitem>
-                    <listitem><para><emphasis><filename>SystemTap</filename>:</emphasis>
-                        Systemtap is a tool that lets you create and reuse
-                        scripts to examine the activities of a live Linux
-                        system.
-                        You can easily extract, filter, and summarize data
-                        that helps you diagnose complex performance or
-                        functional problems.
-                        For more information on setting up and using
-                        <filename>SystemTap</filename>, see the
-                        <ulink url='https://sourceware.org/systemtap/documentation.html'>SystemTap Documentation</ulink>.
-                        </para></listitem>
-                    <listitem><para><emphasis><filename>yocto-bsp</filename>:</emphasis>
-                        The <filename>yocto-bsp</filename> tool lets you
-                        quickly set up a Board Support Package (BSP) layer.
-                        The tool requires a Metadata location, build location,
-                        BSP name, BSP output location, and a kernel
-                        architecture.
-                        For more information on the
-                        <filename>yocto-bsp</filename> tool outside of Eclipse,
-                        see the
-                        "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a new BSP Layer Using the yocto-bsp Script</ulink>"
-                        section in the Yocto Project Board Support Package
-                        (BSP) Developer's Guide.
-                        </para></listitem>
-                </itemizedlist>
            </para>
        </section>
    </section>
author	Scott Rifenbark <srifenbark@gmail.com>	2016-08-12 10:20:16 -0700
committer	Richard Purdie <richard.purdie@linuxfoundation.org>	2016-08-25 23:09:27 +0100
commit	4d5dc4a8908c4f67268f2058e1ea6d76f72ca0ef (patch)
tree	3489d42ca80e9fdb6272d09341c2069b01188ac5 /documentation/sdk-manual/sdk-using.xml
parent	a3f519e19399e239cf1efde523af426f6a519d4f (diff)
download	poky-4d5dc4a8908c4f67268f2058e1ea6d76f72ca0ef.tar.gz

diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml index 9354ace3b9..f8e2f005bd 100644 --- a/documentation/sdk-manual/sdk-using.xml +++ b/documentation/sdk-manual/sdk-using.xml
@@ -533,10 +533,10 @@
533	</para></listitem>	533	</para></listitem>
534	<listitem><para><emphasis>Test and debug the application</emphasis>:	534	<listitem><para><emphasis>Test and debug the application</emphasis>:
535	Once your application is deployed, you need to test it.	535	Once your application is deployed, you need to test it.
536	Within the Eclipse IDE, you can use the debugging environment along with the	536	Within the Eclipse IDE, you can use the debugging
537	set of installed user-space tools to debug your application.	537	environment along with supported performance enhancing
538	Of course, the same user-space tools are available separately if you choose	538	<ulink url='http://www.eclipse.org/linuxtools/'>tools</ulink>.
539	not to use the Eclipse IDE.</para></listitem>	539	</para></listitem>
540	</orderedlist>	540	</orderedlist>
541	</para>	541	</para>
542	</section>	542	</section>
@@ -565,9 +565,11 @@
565	execution of your output into a QEMU emulation session as well as	565	execution of your output into a QEMU emulation session as well as
566	actual target hardware.	566	actual target hardware.
567	You can also perform cross-debugging and profiling.	567	You can also perform cross-debugging and profiling.
568	The environment also supports a suite of tools that allows you	568	The environment also supports performance enhancing
569	to perform remote profiling, tracing, collection of power data,	569	<ulink url='http://www.eclipse.org/linuxtools/'>tools</ulink> that
570	collection of latency data, and collection of performance data.	570	allow you to perform remote profiling, tracing, collection of
		571	power data, collection of latency data, and collection of
		572	performance data.
571	</para>	573	</para>
572		574
573	<para>	575	<para>
@@ -1317,144 +1319,18 @@
1317	</para>	1319	</para>
1318	</section>	1320	</section>
1319		1321
1320	<section id='running-user-space-tools'>	1322	<section id='running-performance-tools'>
1321	<title>Running User-Space Tools</title>	1323	<title>Running Performance Tools</title>
1322		1324
1323	<para>	1325	<para>
1324	As mentioned earlier in the manual, several tools exist that	1326	As mentioned earlier in the manual, several tools exist that
1325	enhance your development experience.	1327	enhance your development experience.
1326	These tools are aids in developing and debugging applications	1328	These tools are aids in developing and debugging applications
1327	and images.	1329	and images.
1328	You can run these user-space tools from within the Eclipse	1330	You can run these tools from within the Eclipse
1329	IDE through the "YoctoProjectTools" menu.	1331	IDE through the "YoctoProjectTools" menu.
1330	</para>	1332	For more information on these tools, see
1331		1333	<ulink url='http://www.eclipse.org/linuxtools/'>http://www.eclipse.org/linuxtools/</ulink>.
1332	<para>
1333	Once you pick a tool, you need to configure it for the remote
1334	target.
1335	Every tool needs to have the connection configured.
1336	You must select an existing TCF-based RSE connection to the
1337	remote target.
1338	If one does not exist, click "New" to create one.
1339	</para>
1340
1341	<para>
1342	Here are some specifics about the remote tools:
1343	<itemizedlist>
1344	<listitem><para><emphasis><filename>Lttng2.0 trace import</filename>:</emphasis>
1345	Selecting this tool transfers the remote target's
1346	<filename>Lttng</filename> tracing data back to the
1347	local host machine and uses the Lttng Eclipse plug-in
1348	to graphically display the output.
1349	For information on how to use Lttng to trace an
1350	application,
1351	see <ulink url='http://lttng.org/documentation'></ulink>
1352	and the
1353	"<ulink url='&YOCTO_DOCS_PROF_URL;#lttng-linux-trace-toolkit-next-generation'>LTTng (Linux Trace Toolkit, next generation)</ulink>"
1354	section, which is in the Yocto Project Profiling and
1355	Tracing Manual.
1356	<note>Do not use
1357	<filename>Lttng-user space (legacy)</filename> tool.
1358	This tool no longer has any upstream support.</note>
1359	</para>
1360	<para>Before you use the
1361	<filename>Lttng2.0 trace import</filename> tool,
1362	you need to setup the Lttng Eclipse plug-in and create a
1363	Tracing project.
1364	Do the following:
1365	<orderedlist>
1366	<listitem><para>Select "Open Perspective" from the
1367	"Window" menu and then select "Other..." to
1368	bring up a menu of other perspectives.
1369	Choose "Tracing".
1370	</para></listitem>
1371	<listitem><para>Click "OK" to change the Eclipse
1372	perspective into the Tracing perspective.
1373	</para></listitem>
1374	<listitem><para>Create a new Tracing project by
1375	selecting "Project" from the "File -> New" menu.
1376	</para></listitem>
1377	<listitem><para>Choose "Tracing Project" from the
1378	"Tracing" menu and click "Next".
1379	</para></listitem>
1380	<listitem><para>Provide a name for your tracing
1381	project and click "Finish".
1382	</para></listitem>
1383	<listitem><para>Generate your tracing data on the
1384	remote target.</para></listitem>
1385	<listitem><para>Select "Lttng2.0 trace import"
1386	from the "Yocto Project Tools" menu to
1387	start the data import process.</para></listitem>
1388	<listitem><para>Specify your remote connection name.
1389	</para></listitem>
1390	<listitem><para>For the Ust directory path, specify
1391	the location of your remote tracing data.
1392	Make sure the location ends with
1393	<filename>ust</filename> (e.g.
1394	<filename>/usr/mysession/ust</filename>).
1395	</para></listitem>
1396	<listitem><para>Click "OK" to complete the import
1397	process.
1398	The data is now in the local tracing project
1399	you created.</para></listitem>
1400	<listitem><para>Right click on the data and then use
1401	the menu to Select "Generic CTF Trace" from the
1402	"Trace Type... -> Common Trace Format" menu to
1403	map the tracing type.</para></listitem>
1404	<listitem><para>Right click the mouse and select
1405	"Open" to bring up the Eclipse Lttng Trace
1406	Viewer so you view the tracing data.
1407	</para></listitem>
1408	</orderedlist></para></listitem>
1409	<listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis>
1410	Selecting this tool runs PowerTOP on the remote target
1411	machine and displays the results in a new view called
1412	PowerTOP.</para>
1413	<para>The "Time to gather data(sec):" field is the time
1414	passed in seconds before data is gathered from the
1415	remote target for analysis.</para>
1416	<para>The "show pids in wakeups list:" field corresponds
1417	to the <filename>-p</filename> argument passed to
1418	<filename>PowerTOP</filename>.</para></listitem>
1419	<listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis>
1420	LatencyTOP identifies system latency, while
1421	Perf monitors the system's performance counter
1422	registers.
1423	Selecting either of these tools causes an RSE terminal
1424	view to appear from which you can run the tools.
1425	Both tools refresh the entire screen to display results
1426	while they run.
1427	For more information on setting up and using
1428	<filename>perf</filename>, see the
1429	"<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>"
1430	section in the Yocto Project Profiling and Tracing
1431	Manual.
1432	</para></listitem>
1433	<listitem><para><emphasis><filename>SystemTap</filename>:</emphasis>
1434	Systemtap is a tool that lets you create and reuse
1435	scripts to examine the activities of a live Linux
1436	system.
1437	You can easily extract, filter, and summarize data
1438	that helps you diagnose complex performance or
1439	functional problems.
1440	For more information on setting up and using
1441	<filename>SystemTap</filename>, see the
1442	<ulink url='https://sourceware.org/systemtap/documentation.html'>SystemTap Documentation</ulink>.
1443	</para></listitem>
1444	<listitem><para><emphasis><filename>yocto-bsp</filename>:</emphasis>
1445	The <filename>yocto-bsp</filename> tool lets you
1446	quickly set up a Board Support Package (BSP) layer.
1447	The tool requires a Metadata location, build location,
1448	BSP name, BSP output location, and a kernel
1449	architecture.
1450	For more information on the
1451	<filename>yocto-bsp</filename> tool outside of Eclipse,
1452	see the
1453	"<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a new BSP Layer Using the yocto-bsp Script</ulink>"
1454	section in the Yocto Project Board Support Package
1455	(BSP) Developer's Guide.
1456	</para></listitem>
1457	</itemizedlist>
1458	</para>	1334	</para>
1459	</section>	1335	</section>
1460	</section>	1336	</section>