summaryrefslogtreecommitdiffstats
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
parent8d689e378a310d1562b1eeffbdb1401996f16023 (diff)
downloadpoky-1b1f8e5260e90460c1bc6eb9a4fdb9e227980d34.tar.gz
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>
-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 @@
336 Quick Test Run</ulink>" section of 336 Quick Test Run</ulink>" section of
337 <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html'> 337 <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html'>
338 The Yocto Project Quick Start</ulink>. 338 The Yocto Project Quick Start</ulink>.
339 <note><para> 339 </para>
340
341 <para>
340 The Yocto Project provides basic kernel and filesystem images for several 342 The Yocto Project provides basic kernel and filesystem images for several
341 architectures (<filename>x86</filename>, <filename>x86-64</filename>, 343 architectures (<filename>x86</filename>, <filename>x86-64</filename>,
342 <filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>) 344 <filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>)
343 that you can use unaltered in the QEMU emulator. 345 that you can use unaltered in the QEMU emulator.
344 These kernel images reside in the Yocto Project release 346 These kernel images reside in the Yocto Project release
345 area - <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/'></ulink> 347 area - <ulink url='http://www.yoctoproject.org/downloads/yocto-1.1/machines/'></ulink>
346 and are ideal for experimentation within Yocto Project.</para> 348 and are ideal for experimentation within Yocto Project.
347 <para>If you plan on remotely deploying and debugging your application from within the 349 For information on the image types you can build using the Yocto Project, see the
348 Eclipse IDE, you must have an image that contains the Yocto Target Communication 350 "<ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink>" appendix in
349 Framework (TCF) agent (<filename>tcf-agent</filename>), which is the
350 <filename>core-image-sato-sdk</filename> image.
351 For information on the image types you can build using the Yocto Project, see
352 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#ref-images'>
353 Reference: Images</ulink> in
354 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html'> 351 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html'>
355 The Yocto Project Reference Manual</ulink>.</para> 352 The Yocto Project Reference Manual</ulink>.
356 </note> 353 </para>
354
355 <para>
356 If you plan on remotely deploying and debugging your application from within the
357 Eclipse IDE, you must have an image that contains the Yocto Target Communication
358 Framework (TCF) agent (<filename>tcf-agent</filename>).
359 By default, the Yocto Project provides only one pre-built image that contains the
360 <filename>tcf-agent</filename>.
361 And, that image is <filename>core-image-sato-sdk</filename>.
362 </para>
363
364 <para>
365 If you want to use a different image type that contains the <filename>tcf-agent</filename>,
366 you can do so one of two ways:
367 <itemizedlist>
368 <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in
369 the Yocto Project build directory and then rebuild the image.
370 With this method you need to modify the <filename>EXTRA_IMAGE_FEATURES</filename>
371 variable to have the value of "tools-debug" before rebuilding the image.
372 Once the image is rebuilt, the <filename>tcf-agent</filename> will be included
373 in the image and is launched automatically after the boot.</para></listitem>
374 <listitem><para>Manually build the <filename>tcf-agent</filename>.
375 To build the agent, follow these steps:
376 <orderedlist>
377 <listitem><para>Be sure the ADT is installed as described in the
378 "<link linkend='installing-the-adt'>Installing the ADT</link>" section.
379 </para></listitem>
380 <listitem><para>Set up the cross-development environment as described in the
381 "<link linkend='setting-up-the-cross-development-environment'>Setting
382 Up the Cross-Development Environment</link>" section.</para></listitem>
383 <listitem><para>Get the <filename>tcf-agent</filename> source code, which is
384 stored using the Subversion SCM, using the following command:
385 <literallayout class='monospaced'>
386 $ svn checkout svn://dev.eclipse.org/svnroot/dsdp/org.eclipse.tm.tcf/trunk/agent \
387 &lt;-r #rev_number&gt;
388 </literallayout></para></listitem>
389 <listitem><para>Modify the <filename>Makefile.inc</filename> file
390 for the cross-compilation environment by setting the
391 <filename>OPSYS</filename> and <filename>MACHINE</filename>
392 variables according to your target.</para></listitem>
393 <listitem><para>Use the cross-development tools to build the
394 <filename>tcf-agent</filename>.
395 Before you "Make" the file, be sure your cross-tools are set up first.
396 See the "<link linkend='makefile-based-projects'>Makefile-Based Projects</link>"
397 section for information on how to make sure the cross-tools are set up
398 correctly.</para>
399 <para>If the build is successful, the <filename>tcf-agent</filename> output will
400 be <filename>obj/$(OPSYS)/$(MACHINE)/Debug/agent</filename>.</para></listitem>
401 <listitem><para>Deploy the agent into the image's root filesystem.</para></listitem>
402 </orderedlist>
403 </para></listitem>
404 </itemizedlist>
357 </para> 405 </para>
358 </section> 406 </section>
359 407