aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-09-30 08:34:48 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-10-04 13:46:43 +0100
commit1b1f8e5260e90460c1bc6eb9a4fdb9e227980d34 (patch)
treedc8f48da7c0a0231916ffcf192adab143c5dd4fa /documentation/adt-manual
parent8d689e378a310d1562b1eeffbdb1401996f16023 (diff)
downloadpoky-1b1f8e5260e90460c1bc6eb9a4fdb9e227980d34.tar.gz
poky-1b1f8e5260e90460c1bc6eb9a4fdb9e227980d34.tar.bz2
poky-1b1f8e5260e90460c1bc6eb9a4fdb9e227980d34.zip
documentation/adt-manual/adt-prepare.xml: Updated for building tcf-agent
The YP only ships one pre-built image that has the tcf-agent built into it - core-image-sato-sdk. There are a couple methods that exist to create images that do not normally have this agent so that they will have it. I updated the "Getting the Images" section to contain those steps. Lianhao and Jessica Zhang were the technical resources for these changes. These changes are the first draft. (From yocto-docs rev: 85432e4892c3fe924bf90961f89e8edfd9693e84) 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-prepare.xml70
1 files changed, 59 insertions, 11 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index 48a82f53ef..8a1bc67599 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -336,24 +336,72 @@
Quick Test Run</ulink>" section of
<ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html'>
The Yocto Project Quick Start</ulink>.
- <note><para>
+ </para>
+
+ <para>
The Yocto Project provides basic kernel and filesystem images for several
architectures (<filename>x86</filename>, <filename>x86-64</filename>,
<filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>)
that you can use unaltered in the QEMU emulator.
These kernel images reside in the Yocto Project release
area - <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/'></ulink>
- and are ideal for experimentation within Yocto Project.</para>
- <para>If you plan on remotely deploying and debugging your application from within the
- Eclipse IDE, you must have an image that contains the Yocto Target Communication
- Framework (TCF) agent (<filename>tcf-agent</filename>), which is the
- <filename>core-image-sato-sdk</filename> image.
- For information on the image types you can build using the Yocto Project, see
- <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#ref-images'>
- Reference: Images</ulink> in
+ and are ideal for experimentation within Yocto Project.
+ For information on the image types you can build using the Yocto Project, see the
+ "<ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink>" appendix in
<ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html'>
- The Yocto Project Reference Manual</ulink>.</para>
- </note>
+ The Yocto Project Reference Manual</ulink>.
+ </para>
+
+ <para>
+ If you plan on remotely deploying and debugging your application from within the
+ Eclipse IDE, you must have an image that contains the Yocto Target Communication
+ Framework (TCF) agent (<filename>tcf-agent</filename>).
+ By default, the Yocto Project provides only one pre-built image that contains the
+ <filename>tcf-agent</filename>.
+ And, that image is <filename>core-image-sato-sdk</filename>.
+ </para>
+
+ <para>
+ If you want to use a different image type that contains the <filename>tcf-agent</filename>,
+ you can do so one of two ways:
+ <itemizedlist>
+ <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in
+ the Yocto Project build directory and then rebuild the image.
+ With this method you need to modify the <filename>EXTRA_IMAGE_FEATURES</filename>
+ variable to have the value of "tools-debug" before rebuilding the image.
+ Once the image is rebuilt, the <filename>tcf-agent</filename> will be included
+ in the image and is launched automatically after the boot.</para></listitem>
+ <listitem><para>Manually build the <filename>tcf-agent</filename>.
+ To build the agent, follow these steps:
+ <orderedlist>
+ <listitem><para>Be sure the ADT is installed as described in the
+ "<link linkend='installing-the-adt'>Installing the ADT</link>" section.
+ </para></listitem>
+ <listitem><para>Set up the cross-development environment as described in the
+ "<link linkend='setting-up-the-cross-development-environment'>Setting
+ Up the Cross-Development Environment</link>" section.</para></listitem>
+ <listitem><para>Get the <filename>tcf-agent</filename> source code, which is
+ stored using the Subversion SCM, using the following command:
+ <literallayout class='monospaced'>
+ $ svn checkout svn://dev.eclipse.org/svnroot/dsdp/org.eclipse.tm.tcf/trunk/agent \
+ &lt;-r #rev_number&gt;
+ </literallayout></para></listitem>
+ <listitem><para>Modify the <filename>Makefile.inc</filename> file
+ for the cross-compilation environment by setting the
+ <filename>OPSYS</filename> and <filename>MACHINE</filename>
+ variables according to your target.</para></listitem>
+ <listitem><para>Use the cross-development tools to build the
+ <filename>tcf-agent</filename>.
+ Before you "Make" the file, be sure your cross-tools are set up first.
+ See the "<link linkend='makefile-based-projects'>Makefile-Based Projects</link>"
+ section for information on how to make sure the cross-tools are set up
+ correctly.</para>
+ <para>If the build is successful, the <filename>tcf-agent</filename> output will
+ be <filename>obj/$(OPSYS)/$(MACHINE)/Debug/agent</filename>.</para></listitem>
+ <listitem><para>Deploy the agent into the image's root filesystem.</para></listitem>
+ </orderedlist>
+ </para></listitem>
+ </itemizedlist>
</para>
</section>