summaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-03-23 12:23:09 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-26 12:13:48 +0100
commit49c911f7051c5483b0280b189f71017bce9c00fb (patch)
treec270dfb4c320bf5c68e68c874467bda7f050e447 /documentation/adt-manual
parentc3fe9d7a36c04a06d9531b28a9d982fd4edee8df (diff)
downloadpoky-49c911f7051c5483b0280b189f71017bce9c00fb.tar.gz
documentation/adt-manual: Edits to fix ADT manual for 1.2 per bug 2025
Addressed all issues specified by [YOCTO #2025] except for the very first one that says bring the versions up to 1.2. This will be accomplished by the poky.ent bump at release time. Fixes [YOCTO #2025] (From yocto-docs rev: 926e5635d8cd74fff7e00002108ce8c039252203) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/adt-manual')
-rw-r--r--documentation/adt-manual/adt-eclipse.xml62
-rw-r--r--documentation/adt-manual/adt-prepare.xml10
2 files changed, 49 insertions, 23 deletions
diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml
index cb642ebed7..dcc201cdc8 100644
--- a/documentation/adt-manual/adt-eclipse.xml
+++ b/documentation/adt-manual/adt-eclipse.xml
@@ -41,7 +41,7 @@
41 <title>Installing the Eclipse IDE</title> 41 <title>Installing the Eclipse IDE</title>
42 42
43 <para> 43 <para>
44 It is recommended that you have the Indigo 3.7 version of the 44 It is recommended that you have the Indigo 3.7.2 version of the
45 Eclipse IDE installed on your development system. 45 Eclipse IDE installed on your development system.
46 If you don’t have this version, you can find it at 46 If you don’t have this version, you can find it at
47 <ulink url='&ECLIPSE_MAIN_URL;'></ulink>. 47 <ulink url='&ECLIPSE_MAIN_URL;'></ulink>.
@@ -106,6 +106,8 @@
106 <listitem><para>Expand the box next to <filename>Programming Languages</filename> 106 <listitem><para>Expand the box next to <filename>Programming Languages</filename>
107 and select the <filename>Autotools Support for CDT (incubation)</filename> 107 and select the <filename>Autotools Support for CDT (incubation)</filename>
108 and <filename>C/C++ Development Tools</filename> boxes.</para></listitem> 108 and <filename>C/C++ Development Tools</filename> boxes.</para></listitem>
109 <listitem><para>Expand the box next to "Linux Tools" and select the
110 "LTTng - Linux Tracing Toolkit(incubation)" boxes.</para></listitem>
109 <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> 111 <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem>
110 <listitem><para>After the Eclipse IDE restarts and from the Workbench, select 112 <listitem><para>After the Eclipse IDE restarts and from the Workbench, select
111 "Install New Software" from the "Help" pull-down menu.</para></listitem> 113 "Install New Software" from the "Help" pull-down menu.</para></listitem>
@@ -144,19 +146,19 @@
144 <title>Installing or Accessing the Eclipse Yocto Plug-in</title> 146 <title>Installing or Accessing the Eclipse Yocto Plug-in</title>
145 147
146 <para> 148 <para>
147 You can install the Eclipse Yocto Plug-in into the Eclipse application 149 You can install the Eclipse Yocto Plug-in into the Eclipse IDE
148 one of two ways: using the Eclipse IDE and installing the plug-in as new software, or 150 one of two ways: use the Yocto Project update site to install the pre-built plug-in,
149 using a built zip file. 151 or build and install the plug-in from the latest source code.
150 If you don't want to permanently install the plug-in but just want to try it out 152 If you don't want to permanently install the plug-in but just want to try it out
151 within the Eclipse environment, you can import the plug-in project from the 153 within the Eclipse environment, you can import the plug-in project from the
152 Yocto Project source repositories. 154 Yocto Project source repositories.
153 </para> 155 </para>
154 156
155 <section id='new-software'> 157 <section id='new-software'>
156 <title>Installing the Plug-in as New Software</title> 158 <title>Installing the Pre-built Plug-in from the Yocto Project Eclipse Update Site</title>
157 159
158 <para> 160 <para>
159 To install the Eclipse Yocto Plug-in as new software directly into the Eclipse IDE, 161 To install the Eclipse Yocto Plug-in from the update site,
160 follow these steps: 162 follow these steps:
161 <orderedlist> 163 <orderedlist>
162 <listitem><para>Start up the Eclipse IDE.</para></listitem> 164 <listitem><para>Start up the Eclipse IDE.</para></listitem>
@@ -179,10 +181,9 @@
179 </section> 181 </section>
180 182
181 <section id='zip-file-method'> 183 <section id='zip-file-method'>
182 <title>Installing the Plug-in from a Zip File</title> 184 <title>Installing the Plug-in Using the Latest Source Code</title>
183 <para> 185 <para>
184 To install the Eclipse Yocto Plug-in by building and installing a plug-in 186 To install the Eclipse Yocto Plug-in from the latest source code, follow these steps:
185 zip file, follow these steps:
186 <orderedlist> 187 <orderedlist>
187 <listitem><para>Open a shell and create a Git repository with: 188 <listitem><para>Open a shell and create a Git repository with:
188 <literallayout class='monospaced'> 189 <literallayout class='monospaced'>
@@ -257,9 +258,9 @@
257 and then click "Next".</para></listitem> 258 and then click "Next".</para></listitem>
258 <listitem><para>Select the root directory and browse to 259 <listitem><para>Select the root directory and browse to
259 <filename>~/yocto-eclipse/plugins</filename>.</para></listitem> 260 <filename>~/yocto-eclipse/plugins</filename>.</para></listitem>
260 <listitem><para>There will be three things there. 261 <listitem><para>Three plug-ins exist: "org.yocto.bc.ui", "org.yocto.sdk.ide", and
261 Select each one and install one at a time. 262 "org.yocto.sdk.remotetools".
262 Do all three.</para></listitem> 263 Select and import all of them.</para></listitem>
263 </orderedlist> 264 </orderedlist>
264 </para> 265 </para>
265 266
@@ -585,11 +586,11 @@
585 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>. 586 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>.
586 <note>The <filename>oprofile-server</filename> is installed by default on 587 <note>The <filename>oprofile-server</filename> is installed by default on
587 the <filename>core-image-sato-sdk</filename> image.</note></para></listitem> 588 the <filename>core-image-sato-sdk</filename> image.</note></para></listitem>
588 <listitem><para><emphasis><filename>Lttng-ust</filename>:</emphasis> Selecting this tool runs 589 <listitem><para><emphasis><filename>Lttng-ust</filename>:</emphasis> Selecting this tool runs
589 <filename>usttrace</filename> on the remote target, transfers the output data back to the 590 <filename>usttrace</filename> on the remote target, transfers the output data back
590 local host machine, and uses <filename>lttv-gui</filename> to graphically display the output. 591 to the local host machine, and uses the <filename>lttng</filename> Eclipse plug-in to
591 The <filename>lttv-gui</filename> must be installed on the local host machine to use this tool. 592 graphically display the output.
592 For information on how to use <filename>lttng</filename> to trace an application, see 593 For information on how to use <filename>lttng</filename> to trace an application, see
593 <ulink url='http://lttng.org/files/ust/manual/ust.html'></ulink>.</para> 594 <ulink url='http://lttng.org/files/ust/manual/ust.html'></ulink>.</para>
594 <para>For <filename>Application</filename>, you must supply the absolute path name of the 595 <para>For <filename>Application</filename>, you must supply the absolute path name of the
595 application to be traced by user mode <filename>lttng</filename>. 596 application to be traced by user mode <filename>lttng</filename>.
@@ -597,7 +598,32 @@
597 <filename>usttrace /path/to/foo</filename> on the remote target to trace the 598 <filename>usttrace /path/to/foo</filename> on the remote target to trace the
598 program <filename>/path/to/foo</filename>.</para> 599 program <filename>/path/to/foo</filename>.</para>
599 <para><filename>Argument</filename> is passed to <filename>usttrace</filename> 600 <para><filename>Argument</filename> is passed to <filename>usttrace</filename>
600 running on the remote target.</para></listitem> 601 running on the remote target.</para>
602 <para>Before you use the <filename>lttng-ust</filename> tool, you need to setup
603 the <filename>lttng</filename> Eclipse plug-in and create a <filename>lttng</filename>
604 project.
605 Do the following:
606 <orderedlist>
607 <listitem><para>Follow these
608 <ulink url='http://wiki.eclipse.org/Linux_Tools_Project/LTTng#Downloading_and_installing_the_LTTng_parser_library'>instructions</ulink>
609 to download and install the <filename>lttng</filename> parser library.
610 </para></listitem>
611 <listitem><para>Select <filename>Window -> Open Perspective -> Other</filename>
612 and then select <filename>LTTng</filename>.</para></listitem>
613 <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective
614 into the <filename>LTTng</filename> perspective.</para></listitem>
615 <listitem><para>Create a new <filename>LTTng</filename> project by selecting
616 <filename>File -> New -> Project</filename>.</para></listitem>
617 <listitem><para>Choose <filename>LTTng -> LTTng Project</filename>.</para></listitem>
618 <listitem><para>Click <filename>YoctoTools -> lttng-ust</filename> to start user mode
619 <filename>lttng</filename> on the remote target.</para></listitem>
620 </orderedlist></para>
621 <para>After the output data has been transferred from the remote target back to the local
622 host machine, new traces will be imported into the selected <filename>LTTng</filename> project.
623 Then you can go to the <filename>LTTng</filename> project, right click the imported
624 trace, and set the trace type as the <filename>LTTng</filename> kernel trace.
625 Finally, right click the imported trace and select <filename>Open</filename>
626 to display the data graphically.</para></listitem>
601 <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs 627 <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs
602 <filename>powertop</filename> on the remote target machine and displays the results in a 628 <filename>powertop</filename> on the remote target machine and displays the results in a
603 new view called <filename>powertop</filename>.</para> 629 new view called <filename>powertop</filename>.</para>
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index 9880fcc7d1..3ced7f6ded 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -168,7 +168,7 @@
168 After you have configured the <filename>adt_installer.conf</filename> file, 168 After you have configured the <filename>adt_installer.conf</filename> file,
169 run the installer using the following command: 169 run the installer using the following command:
170 <literallayout class='monospaced'> 170 <literallayout class='monospaced'>
171 $ adt_installer 171 $ ./adt_installer
172 </literallayout> 172 </literallayout>
173 </para> 173 </para>
174 174
@@ -384,11 +384,11 @@
384 <listitem><para>Set up the cross-development environment as described in the 384 <listitem><para>Set up the cross-development environment as described in the
385 "<link linkend='setting-up-the-cross-development-environment'>Setting 385 "<link linkend='setting-up-the-cross-development-environment'>Setting
386 Up the Cross-Development Environment</link>" section.</para></listitem> 386 Up the Cross-Development Environment</link>" section.</para></listitem>
387 <listitem><para>Get the <filename>tcf-agent</filename> source code, which is 387 <listitem><para>Get the <filename>tcf-agent</filename> source code using
388 stored using the Subversion SCM, using the following command: 388 the following commands:
389 <literallayout class='monospaced'> 389 <literallayout class='monospaced'>
390 $ svn checkout svn://dev.eclipse.org/svnroot/dsdp/org.eclipse.tm.tcf/trunk/agent \ 390 $ git clone http://git.eclipse.org/gitroot/tcf/org.eclipse.tcf.agent.git
391 &lt;-r #rev_number&gt; 391 $ cd agent
392 </literallayout></para></listitem> 392 </literallayout></para></listitem>
393 <listitem><para>Modify the <filename>Makefile.inc</filename> file 393 <listitem><para>Modify the <filename>Makefile.inc</filename> file
394 for the cross-compilation environment by setting the 394 for the cross-compilation environment by setting the