documentation/adt-manual/adt-eclipse.xml: 1.1.2 variables and updates

First pass at implementing the poky.ent variables.  Also corrected
text as needed.

(From yocto-docs rev: 1eecf5e4f706db5abbee7d819e612002f2425d6e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

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 @@
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
+[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
 
 <chapter id='adt-eclipse'>
 <title>Working Within Eclipse</title>
@@ -34,6 +35,11 @@
             <listitem><para>Install the Eclipse Yocto Plug-in.</para></listitem>
             <listitem><para>Configure the Eclipse Yocto Plug-in.</para></listitem>
         </orderedlist>
+        <note>
+            Do not install Eclipse from your distribution's package repository.
+            Be sure to install Eclipse from the official Eclipse download site as directed
+            in the next section.
+        </note>
     </para>
 
     <section id='installing-eclipse-ide'>
@@ -43,7 +49,7 @@
             It is recommended that you have the Indigo 3.7 version of the 
             Eclipse IDE installed on your development system.  
             If you don’t have this version, you can find it at 
-            <ulink url='http://www.eclipse.org/downloads'></ulink>.  
+            <ulink url='&ECLIPSE_MAIN_URL;'></ulink>.  
             From that site, choose the Eclipse Classic version particular to your development
             host.  
             This version contains the Eclipse Platform, the Java Development 
@@ -100,20 +106,22 @@
                 <listitem><para>Make sure you are in your Workbench and select 
                     "Install New Software" from the "Help" pull-down menu.
                     </para></listitem>
-                <listitem><para>Select <filename>indigo - http://download.eclipse.org/releases/indigo</filename>
+                <listitem><para>Select <filename>indigo - &ECLIPSE_INDIGO_URL;</filename>
                     from the "Work with:" pull-down menu.</para></listitem>
                 <listitem><para>Expand the box next to <filename>Programming Languages</filename>
                     and select the <filename>Autotools Support for CDT (incubation)</filename>
                     and <filename>C/C++ Development Tools</filename> boxes.</para></listitem>
+                <listitem><para>Expand the box next to "Linux Tools" and select the 
+                    "LTTng - Linux Tracing Toolkit(incubation)" boxes.</para></listitem>
                 <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem>
                 <listitem><para>After the Eclipse IDE restarts and from the Workbench, select 
                     "Install New Software" from the "Help" pull-down menu.</para></listitem>
                 <listitem><para>Click the 
                     "Available Software Sites" link.</para></listitem>
                 <listitem><para>Check the box next to 
-                    <filename>http://download.eclipse.org/tm/updates/3.3</filename>
+                    <filename>&ECLIPSE_UPDATES_URL;</filename>
                     and click "OK".</para></listitem>
-                <listitem><para>Select <filename>http://download.eclipse.org/tm/updates/3.3</filename>
+                <listitem><para>Select <filename>&ECLIPSE_UPDATES_URL;</filename>
                     from the "Work with:" pull-down menu.</para></listitem>
                 <listitem><para>Check the box next to <filename>TM and RSE Main Features</filename>.
                     </para></listitem>
@@ -127,7 +135,7 @@
                 <listitem><para>After clicking "Available Software Sites", check the box next to 
                     <filename>http://download.eclipse.org/tools/cdt/releases/indigo</filename>
                     and click "OK".</para></listitem>
-                <listitem><para>Select <filename>http://download.eclipse.org/tools/cdt/releases/indigo</filename>
+                <listitem><para>Select <filename>&ECLIPSE_INDIGO_CDT_URL;</filename>
                     from the "Work with:" pull-down menu.</para></listitem>
                 <listitem><para>Check the box next to <filename>CDT Main Features</filename>.
                     </para></listitem>
@@ -162,7 +170,7 @@
                     <listitem><para>In Eclipse, select "Install New Software" from the "Help" menu.</para></listitem>
                     <listitem><para>Click "Add..." in the "Work with:" area.</para></listitem>
                     <listitem><para>Enter 
-                        <filename>http://downloads.yoctoproject.org/releases/eclipse-plugin/1.1.1</filename> 
+                        <filename>&ECLIPSE_DL_PLUGIN_URL;</filename> 
                         in the URL field and provide a meaningful name in the "Name" field.</para></listitem>
                     <listitem><para>Click "OK" to have the entry added to the "Work with:" 
                         drop-down list.</para></listitem>
@@ -204,9 +212,9 @@
                         name of the Git branch along with the Yocto Project release you are 
                         using.
                         Here is an example that uses the <filename>master</filename> Git repository
-                        and the <filename>1.1.1</filename> release:
+                        and the <filename>&DISTRO;</filename> release:
                         <literallayout class='monospaced'>
-     $ scripts/build.sh master 1.1.1 
+     $ scripts/build.sh master &DISTRO; 
                         </literallayout>
                         After running the script, the file
                         <filename>org.yocto.sdk-&lt;release&gt;-&lt;date&gt;-archive.zip</filename>
@@ -322,7 +330,7 @@
                         </para></listitem>
                     <listitem><para><emphasis>Point to the Toolchain:</emphasis>
                         If you are using a stand-alone pre-built toolchain, you should be pointing to the
-                        <filename>/opt/poky/1.1.1</filename> directory.
+                        <filename>&YOCTO_ADTPATH_DIR;</filename> directory.
                         This is the location for toolchains installed by the ADT Installer or by hand.
                         Sections "<link linkend='configuring-and-running-the-adt-installer-script'>Configuring 
                         and Running the ADT Installer Script</link>" and 
@@ -354,7 +362,7 @@
                         The pull-down menu should have the supported architectures.  
                         If the architecture you need is not listed in the menu, you 
                         will need to build the image.
-                        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 
+                        See the "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section 
                         of The Yocto Project Quick Start for more information.</para></listitem>
                 </itemizedlist>
             </para>
@@ -581,14 +589,14 @@
                 host can use, you must have <filename>oprofile</filename> version 0.9.4 or 
                 greater installed on the host.</para>
                 <para>You can locate both the viewer and server from 
-                <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/oprofileui/'></ulink>.
+                <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>.
                 <note>The <filename>oprofile-server</filename> is installed by default on 
                 the <filename>core-image-sato-sdk</filename> image.</note></para></listitem>
-            <listitem><para><emphasis><filename>Lttng-ust</filename>:</emphasis> Selecting this tool runs 
-                <filename>usttrace</filename> on the remote target, transfers the output data back to the 
-                local host machine, and uses <filename>lttv-gui</filename> to graphically display the output.  
-                The <filename>lttv-gui</filename> must be installed on the local host machine to use this tool.  
-                For information on how to use <filename>lttng</filename> to trace an application, see 
+            <listitem><para><emphasis><filename>Lttng-ust</filename>:</emphasis> Selecting this tool runs
+                <filename>usttrace</filename> on the remote target, transfers the output data back 
+                to the local host machine, and uses the <filename>lttng</filename> Eclipse plug-in to 
+                graphically display the output. 
+                For information on how to use <filename>lttng</filename> to trace an application, see
                 <ulink url='http://lttng.org/files/ust/manual/ust.html'></ulink>.</para>
                 <para>For <filename>Application</filename>, you must supply the absolute path name of the 
                 application to be traced by user mode <filename>lttng</filename>.  
@@ -596,7 +604,32 @@
                 <filename>usttrace /path/to/foo</filename> on the remote target to trace the 
                 program <filename>/path/to/foo</filename>.</para>
                 <para><filename>Argument</filename> is passed to <filename>usttrace</filename>
-                running on the remote target.</para></listitem>
+                running on the remote target.</para>
+                <para>Before you use the <filename>lttng-ust</filename> tool, you need to setup 
+                the <filename>lttng</filename> Eclipse plug-in and create a <filename>lttng</filename>
+                project.
+                Do the following:
+                <orderedlist>
+                    <listitem><para>Follow these 
+                        <ulink url='http://wiki.eclipse.org/Linux_Tools_Project/LTTng#Downloading_and_installing_the_LTTng_parser_library'>instructions</ulink>
+                        to download and install the <filename>lttng</filename> parser library.
+                        </para></listitem>
+                    <listitem><para>Select <filename>Window -> Open Perspective -> Other</filename>
+                        and then select <filename>LTTng</filename>.</para></listitem>
+                    <listitem><para>Click <filename>OK</filename> to change the Eclipse perspective 
+                        into the <filename>LTTng</filename> perspective.</para></listitem>
+                    <listitem><para>Create a new <filename>LTTng</filename> project by selecting 
+                        <filename>File -> New -> Project</filename>.</para></listitem>
+                    <listitem><para>Choose <filename>LTTng -> LTTng Project</filename>.</para></listitem>
+                    <listitem><para>Click <filename>YoctoTools -> lttng-ust</filename> to start user mode 
+                        <filename>lttng</filename> on the remote target.</para></listitem>
+                </orderedlist></para>
+                <para>After the output data has been transferred from the remote target back to the local
+                host machine, new traces will be imported into the selected <filename>LTTng</filename> project.
+                Then you can go to the <filename>LTTng</filename> project, right click the imported 
+                trace, and set the trace type as the <filename>LTTng</filename> kernel trace.
+                Finally, right click the imported trace and select <filename>Open</filename>
+                to display the data graphically.</para></listitem>
             <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs 
                 <filename>powertop</filename> on the remote target machine and displays the results in a 
                 new view called <filename>powertop</filename>.</para>