summaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual/adt-eclipse.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/adt-manual/adt-eclipse.xml')
-rw-r--r--documentation/adt-manual/adt-eclipse.xml69
1 files changed, 51 insertions, 18 deletions
diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml
index 95d71c4c93..2123198064 100644
--- a/documentation/adt-manual/adt-eclipse.xml
+++ b/documentation/adt-manual/adt-eclipse.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<chapter id='adt-eclipse'> 5<chapter id='adt-eclipse'>
5<title>Working Within Eclipse</title> 6<title>Working Within Eclipse</title>
@@ -34,6 +35,11 @@
34 <listitem><para>Install the Eclipse Yocto Plug-in.</para></listitem> 35 <listitem><para>Install the Eclipse Yocto Plug-in.</para></listitem>
35 <listitem><para>Configure the Eclipse Yocto Plug-in.</para></listitem> 36 <listitem><para>Configure the Eclipse Yocto Plug-in.</para></listitem>
36 </orderedlist> 37 </orderedlist>
38 <note>
39 Do not install Eclipse from your distribution's package repository.
40 Be sure to install Eclipse from the official Eclipse download site as directed
41 in the next section.
42 </note>
37 </para> 43 </para>
38 44
39 <section id='installing-eclipse-ide'> 45 <section id='installing-eclipse-ide'>
@@ -43,7 +49,7 @@
43 It is recommended that you have the Indigo 3.7 version of the 49 It is recommended that you have the Indigo 3.7 version of the
44 Eclipse IDE installed on your development system. 50 Eclipse IDE installed on your development system.
45 If you don’t have this version, you can find it at 51 If you don’t have this version, you can find it at
46 <ulink url='http://www.eclipse.org/downloads'></ulink>. 52 <ulink url='&ECLIPSE_MAIN_URL;'></ulink>.
47 From that site, choose the Eclipse Classic version particular to your development 53 From that site, choose the Eclipse Classic version particular to your development
48 host. 54 host.
49 This version contains the Eclipse Platform, the Java Development 55 This version contains the Eclipse Platform, the Java Development
@@ -100,20 +106,22 @@
100 <listitem><para>Make sure you are in your Workbench and select 106 <listitem><para>Make sure you are in your Workbench and select
101 "Install New Software" from the "Help" pull-down menu. 107 "Install New Software" from the "Help" pull-down menu.
102 </para></listitem> 108 </para></listitem>
103 <listitem><para>Select <filename>indigo - http://download.eclipse.org/releases/indigo</filename> 109 <listitem><para>Select <filename>indigo - &ECLIPSE_INDIGO_URL;</filename>
104 from the "Work with:" pull-down menu.</para></listitem> 110 from the "Work with:" pull-down menu.</para></listitem>
105 <listitem><para>Expand the box next to <filename>Programming Languages</filename> 111 <listitem><para>Expand the box next to <filename>Programming Languages</filename>
106 and select the <filename>Autotools Support for CDT (incubation)</filename> 112 and select the <filename>Autotools Support for CDT (incubation)</filename>
107 and <filename>C/C++ Development Tools</filename> boxes.</para></listitem> 113 and <filename>C/C++ Development Tools</filename> boxes.</para></listitem>
114 <listitem><para>Expand the box next to "Linux Tools" and select the
115 "LTTng - Linux Tracing Toolkit(incubation)" boxes.</para></listitem>
108 <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> 116 <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem>
109 <listitem><para>After the Eclipse IDE restarts and from the Workbench, select 117 <listitem><para>After the Eclipse IDE restarts and from the Workbench, select
110 "Install New Software" from the "Help" pull-down menu.</para></listitem> 118 "Install New Software" from the "Help" pull-down menu.</para></listitem>
111 <listitem><para>Click the 119 <listitem><para>Click the
112 "Available Software Sites" link.</para></listitem> 120 "Available Software Sites" link.</para></listitem>
113 <listitem><para>Check the box next to 121 <listitem><para>Check the box next to
114 <filename>http://download.eclipse.org/tm/updates/3.3</filename> 122 <filename>&ECLIPSE_UPDATES_URL;</filename>
115 and click "OK".</para></listitem> 123 and click "OK".</para></listitem>
116 <listitem><para>Select <filename>http://download.eclipse.org/tm/updates/3.3</filename> 124 <listitem><para>Select <filename>&ECLIPSE_UPDATES_URL;</filename>
117 from the "Work with:" pull-down menu.</para></listitem> 125 from the "Work with:" pull-down menu.</para></listitem>
118 <listitem><para>Check the box next to <filename>TM and RSE Main Features</filename>. 126 <listitem><para>Check the box next to <filename>TM and RSE Main Features</filename>.
119 </para></listitem> 127 </para></listitem>
@@ -127,7 +135,7 @@
127 <listitem><para>After clicking "Available Software Sites", check the box next to 135 <listitem><para>After clicking "Available Software Sites", check the box next to
128 <filename>http://download.eclipse.org/tools/cdt/releases/indigo</filename> 136 <filename>http://download.eclipse.org/tools/cdt/releases/indigo</filename>
129 and click "OK".</para></listitem> 137 and click "OK".</para></listitem>
130 <listitem><para>Select <filename>http://download.eclipse.org/tools/cdt/releases/indigo</filename> 138 <listitem><para>Select <filename>&ECLIPSE_INDIGO_CDT_URL;</filename>
131 from the "Work with:" pull-down menu.</para></listitem> 139 from the "Work with:" pull-down menu.</para></listitem>
132 <listitem><para>Check the box next to <filename>CDT Main Features</filename>. 140 <listitem><para>Check the box next to <filename>CDT Main Features</filename>.
133 </para></listitem> 141 </para></listitem>
@@ -162,7 +170,7 @@
162 <listitem><para>In Eclipse, select "Install New Software" from the "Help" menu.</para></listitem> 170 <listitem><para>In Eclipse, select "Install New Software" from the "Help" menu.</para></listitem>
163 <listitem><para>Click "Add..." in the "Work with:" area.</para></listitem> 171 <listitem><para>Click "Add..." in the "Work with:" area.</para></listitem>
164 <listitem><para>Enter 172 <listitem><para>Enter
165 <filename>http://downloads.yoctoproject.org/releases/eclipse-plugin/1.1.1</filename> 173 <filename>&ECLIPSE_DL_PLUGIN_URL;</filename>
166 in the URL field and provide a meaningful name in the "Name" field.</para></listitem> 174 in the URL field and provide a meaningful name in the "Name" field.</para></listitem>
167 <listitem><para>Click "OK" to have the entry added to the "Work with:" 175 <listitem><para>Click "OK" to have the entry added to the "Work with:"
168 drop-down list.</para></listitem> 176 drop-down list.</para></listitem>
@@ -204,9 +212,9 @@
204 name of the Git branch along with the Yocto Project release you are 212 name of the Git branch along with the Yocto Project release you are
205 using. 213 using.
206 Here is an example that uses the <filename>master</filename> Git repository 214 Here is an example that uses the <filename>master</filename> Git repository
207 and the <filename>1.1.1</filename> release: 215 and the <filename>&DISTRO;</filename> release:
208 <literallayout class='monospaced'> 216 <literallayout class='monospaced'>
209 $ scripts/build.sh master 1.1.1 217 $ scripts/build.sh master &DISTRO;
210 </literallayout> 218 </literallayout>
211 After running the script, the file 219 After running the script, the file
212 <filename>org.yocto.sdk-&lt;release&gt;-&lt;date&gt;-archive.zip</filename> 220 <filename>org.yocto.sdk-&lt;release&gt;-&lt;date&gt;-archive.zip</filename>
@@ -322,7 +330,7 @@
322 </para></listitem> 330 </para></listitem>
323 <listitem><para><emphasis>Point to the Toolchain:</emphasis> 331 <listitem><para><emphasis>Point to the Toolchain:</emphasis>
324 If you are using a stand-alone pre-built toolchain, you should be pointing to the 332 If you are using a stand-alone pre-built toolchain, you should be pointing to the
325 <filename>/opt/poky/1.1.1</filename> directory. 333 <filename>&YOCTO_ADTPATH_DIR;</filename> directory.
326 This is the location for toolchains installed by the ADT Installer or by hand. 334 This is the location for toolchains installed by the ADT Installer or by hand.
327 Sections "<link linkend='configuring-and-running-the-adt-installer-script'>Configuring 335 Sections "<link linkend='configuring-and-running-the-adt-installer-script'>Configuring
328 and Running the ADT Installer Script</link>" and 336 and Running the ADT Installer Script</link>" and
@@ -354,7 +362,7 @@
354 The pull-down menu should have the supported architectures. 362 The pull-down menu should have the supported architectures.
355 If the architecture you need is not listed in the menu, you 363 If the architecture you need is not listed in the menu, you
356 will need to build the image. 364 will need to build the image.
357 See the "<ulink url='http://www.yoctoproject.org/docs/1.1.1/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" section 365 See the "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section
358 of The Yocto Project Quick Start for more information.</para></listitem> 366 of The Yocto Project Quick Start for more information.</para></listitem>
359 </itemizedlist> 367 </itemizedlist>
360 </para> 368 </para>
@@ -581,14 +589,14 @@
581 host can use, you must have <filename>oprofile</filename> version 0.9.4 or 589 host can use, you must have <filename>oprofile</filename> version 0.9.4 or
582 greater installed on the host.</para> 590 greater installed on the host.</para>
583 <para>You can locate both the viewer and server from 591 <para>You can locate both the viewer and server from
584 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/oprofileui/'></ulink>. 592 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>.
585 <note>The <filename>oprofile-server</filename> is installed by default on 593 <note>The <filename>oprofile-server</filename> is installed by default on
586 the <filename>core-image-sato-sdk</filename> image.</note></para></listitem> 594 the <filename>core-image-sato-sdk</filename> image.</note></para></listitem>
587 <listitem><para><emphasis><filename>Lttng-ust</filename>:</emphasis> Selecting this tool runs 595 <listitem><para><emphasis><filename>Lttng-ust</filename>:</emphasis> Selecting this tool runs
588 <filename>usttrace</filename> on the remote target, transfers the output data back to the 596 <filename>usttrace</filename> on the remote target, transfers the output data back
589 local host machine, and uses <filename>lttv-gui</filename> to graphically display the output. 597 to the local host machine, and uses the <filename>lttng</filename> Eclipse plug-in to
590 The <filename>lttv-gui</filename> must be installed on the local host machine to use this tool. 598 graphically display the output.
591 For information on how to use <filename>lttng</filename> to trace an application, see 599 For information on how to use <filename>lttng</filename> to trace an application, see
592 <ulink url='http://lttng.org/files/ust/manual/ust.html'></ulink>.</para> 600 <ulink url='http://lttng.org/files/ust/manual/ust.html'></ulink>.</para>
593 <para>For <filename>Application</filename>, you must supply the absolute path name of the 601 <para>For <filename>Application</filename>, you must supply the absolute path name of the
594 application to be traced by user mode <filename>lttng</filename>. 602 application to be traced by user mode <filename>lttng</filename>.
@@ -596,7 +604,32 @@
596 <filename>usttrace /path/to/foo</filename> on the remote target to trace the 604 <filename>usttrace /path/to/foo</filename> on the remote target to trace the
597 program <filename>/path/to/foo</filename>.</para> 605 program <filename>/path/to/foo</filename>.</para>
598 <para><filename>Argument</filename> is passed to <filename>usttrace</filename> 606 <para><filename>Argument</filename> is passed to <filename>usttrace</filename>
599 running on the remote target.</para></listitem> 607 running on the remote target.</para>
608 <para>Before you use the <filename>lttng-ust</filename> tool, you need to setup
609 the <filename>lttng</filename> Eclipse plug-in and create a <filename>lttng</filename>
610 project.
611 Do the following:
612 <orderedlist>
613 <listitem><para>Follow these
614 <ulink url='http://wiki.eclipse.org/Linux_Tools_Project/LTTng#Downloading_and_installing_the_LTTng_parser_library'>instructions</ulink>
615 to download and install the <filename>lttng</filename> parser library.
616 </para></listitem>
617 <listitem><para>Select <filename>Window -> Open Perspective -> Other</filename>
618 and then select <filename>LTTng</filename>.</para></listitem>
619 <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective
620 into the <filename>LTTng</filename> perspective.</para></listitem>
621 <listitem><para>Create a new <filename>LTTng</filename> project by selecting
622 <filename>File -> New -> Project</filename>.</para></listitem>
623 <listitem><para>Choose <filename>LTTng -> LTTng Project</filename>.</para></listitem>
624 <listitem><para>Click <filename>YoctoTools -> lttng-ust</filename> to start user mode
625 <filename>lttng</filename> on the remote target.</para></listitem>
626 </orderedlist></para>
627 <para>After the output data has been transferred from the remote target back to the local
628 host machine, new traces will be imported into the selected <filename>LTTng</filename> project.
629 Then you can go to the <filename>LTTng</filename> project, right click the imported
630 trace, and set the trace type as the <filename>LTTng</filename> kernel trace.
631 Finally, right click the imported trace and select <filename>Open</filename>
632 to display the data graphically.</para></listitem>
600 <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs 633 <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs
601 <filename>powertop</filename> on the remote target machine and displays the results in a 634 <filename>powertop</filename> on the remote target machine and displays the results in a
602 new view called <filename>powertop</filename>.</para> 635 new view called <filename>powertop</filename>.</para>