diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2015-05-11 12:46:47 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2015-07-28 18:02:29 +0100 |
commit | 6e12a35e3d912f76c8ad88504b4fdf6ceaf1d6c5 (patch) | |
tree | 46bb73e6b49f74dbc080b594103c87f86c31b6e5 | |
parent | d9cf5753df7355b30309cc0640c2180eb3b38780 (diff) | |
download | poky-6e12a35e3d912f76c8ad88504b4fdf6ceaf1d6c5.tar.gz |
adt-manual: Updated the "Getting the Images" section for eclipse-debug
The way to include tcf-agent now in an image that you are going to
remotely deploy and debug using the Eclipse IDE is to simply include
the eclipse-debug image feature as part of the image. I updated the
section around getting images to reflect this simple method.
Reported-by: Adam Lee <adam@gumstix.com>
(From yocto-docs rev: 9aec91d7f4fda558baa0e8a0290b42d76e735c63)
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.xml | 82 |
1 files changed, 24 insertions, 58 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index 8776645207..814adbd615 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml | |||
@@ -480,8 +480,8 @@ | |||
480 | and are ideal for experimentation using Yocto Project. | 480 | and are ideal for experimentation using Yocto Project. |
481 | For information on the image types you can build using the OpenEmbedded build system, | 481 | For information on the image types you can build using the OpenEmbedded build system, |
482 | see the | 482 | see the |
483 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in | 483 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" |
484 | the Yocto Project Reference Manual. | 484 | chapter in the Yocto Project Reference Manual. |
485 | </para> | 485 | </para> |
486 | 486 | ||
487 | <para> | 487 | <para> |
@@ -492,62 +492,28 @@ | |||
492 | </para> | 492 | </para> |
493 | 493 | ||
494 | <para> | 494 | <para> |
495 | Furthermore, if you plan on remotely deploying and debugging your | 495 | If you plan on remotely deploying and debugging your |
496 | application from within the | 496 | application from within the Eclipse IDE, you must have an image |
497 | Eclipse IDE, you must have an image that contains the Yocto Target Communication | 497 | that contains the Yocto Target Communication Framework (TCF) agent |
498 | Framework (TCF) agent (<filename>tcf-agent</filename>). | 498 | (<filename>tcf-agent</filename>). |
499 | By default, the Yocto Project provides only one type of pre-built | 499 | You can do this by including the <filename>eclipse-debug</filename> |
500 | image that contains the <filename>tcf-agent</filename>. | 500 | image feature. |
501 | And, those images are SDK (e.g.<filename>core-image-sato-sdk</filename>). | 501 | <note> |
502 | </para> | 502 | See the |
503 | 503 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-features-image'>Image Features</ulink>" | |
504 | <para> | 504 | section in the Yocto Project Reference Manual for information on |
505 | If you want to use a different image type that contains the <filename>tcf-agent</filename>, | 505 | image features. |
506 | you can do so one of two ways: | 506 | </note> |
507 | <itemizedlist> | 507 | To include the <filename>eclipse-debug</filename> image feature, |
508 | <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in | 508 | modify your <filename>local.conf</filename> file in the |
509 | the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 509 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
510 | and then rebuild the image. | 510 | so that the |
511 | With this method, you need to modify the | 511 | <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink> |
512 | <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink> | 512 | variable includes the "eclipse-debug" feature. |
513 | variable to have the value of "tools-debug" before rebuilding the image. | 513 | After modifying the configuration file, you can rebuild the image. |
514 | Once the image is rebuilt, the <filename>tcf-agent</filename> will be included | 514 | Once the image is rebuilt, the <filename>tcf-agent</filename> |
515 | in the image and is launched automatically after the boot.</para></listitem> | 515 | will be included in the image and is launched automatically after |
516 | <listitem><para>Manually build the <filename>tcf-agent</filename>. | 516 | the boot. |
517 | To build the agent, follow these steps: | ||
518 | <orderedlist> | ||
519 | <listitem><para>Be sure the ADT is installed as described in the | ||
520 | "<link linkend='installing-the-adt'>Installing the ADT and Toolchains</link>" section. | ||
521 | </para></listitem> | ||
522 | <listitem><para>Set up the cross-development environment as described in the | ||
523 | "<link linkend='setting-up-the-cross-development-environment'>Setting | ||
524 | Up the Cross-Development Environment</link>" section.</para></listitem> | ||
525 | <listitem><para>Get the <filename>tcf-agent</filename> source code using | ||
526 | the following commands: | ||
527 | <literallayout class='monospaced'> | ||
528 | $ git clone http://git.eclipse.org/gitroot/tcf/org.eclipse.tcf.agent.git | ||
529 | $ cd org.eclipse.tcf.agent/agent | ||
530 | </literallayout></para></listitem> | ||
531 | <listitem><para>Locate the | ||
532 | <filename>Makefile.inc</filename> file inside the | ||
533 | <filename>agent</filename> folder and modify it | ||
534 | for the cross-compilation environment by setting the | ||
535 | <filename>OPSYS</filename> and | ||
536 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> | ||
537 | variables according to your target. | ||
538 | </para></listitem> | ||
539 | <listitem><para>Use the cross-development tools to build the | ||
540 | <filename>tcf-agent</filename>. | ||
541 | Before you "Make" the file, be sure your cross-tools are set up first. | ||
542 | See the "<link linkend='makefile-based-projects'>Makefile-Based Projects</link>" | ||
543 | section for information on how to make sure the cross-tools are set up | ||
544 | correctly.</para> | ||
545 | <para>If the build is successful, the <filename>tcf-agent</filename> output will | ||
546 | be <filename>obj/$(OPSYS)/$(MACHINE)/Debug/agent</filename>.</para></listitem> | ||
547 | <listitem><para>Deploy the agent into the image's root filesystem.</para></listitem> | ||
548 | </orderedlist> | ||
549 | </para></listitem> | ||
550 | </itemizedlist> | ||
551 | </para> | 517 | </para> |
552 | </section> | 518 | </section> |
553 | 519 | ||