summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-model.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-08-14 13:36:32 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-09-04 12:54:54 +0100
commit4972e8f49cd42c40b0f0c34ab05bdaa034dc1596 (patch)
tree6c4066d379a96fdf64d1d4d4496933a72a4bb174 /documentation/dev-manual/dev-manual-model.xml
parent9674b1a4d399f7cb2b979b3cf5131053037603f1 (diff)
downloadpoky-4972e8f49cd42c40b0f0c34ab05bdaa034dc1596.tar.gz
documentation: Added install and config steps for Juno 4.2
Fixes [YOCTO #2929] Provided an updated section on how to install and configure the Eclipse IDE so that it supports both Juno 4.2 and Indigo 3.7.2. The fix included creating a new poky.ent variable that is Juno-specific. (From yocto-docs rev: 6b0b046322420f56feb644eb6de8341dfac59df2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-model.xml')
-rw-r--r--documentation/dev-manual/dev-manual-model.xml100
1 files changed, 82 insertions, 18 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 3bfd1a3963..32a948bb94 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -525,7 +525,7 @@
525 <title>Application Development Workflow</title> 525 <title>Application Development Workflow</title>
526 526
527 <para> 527 <para>
528 Application development involves creation of an application that you want to be able 528 Application development involves creating an application that you want
529 to run on your target hardware, which is running a kernel image created using the 529 to run on your target hardware, which is running a kernel image created using the
530 OpenEmbedded build system. 530 OpenEmbedded build system.
531 The Yocto Project provides an Application Development Toolkit (ADT) and 531 The Yocto Project provides an Application Development Toolkit (ADT) and
@@ -538,8 +538,8 @@
538 </para> 538 </para>
539 539
540 <para> 540 <para>
541 While we strongly suggest using the ADT to develop your application, you might 541 While we strongly suggest using the ADT to develop your application, this option might not
542 not want to. 542 be best for you.
543 If this is the case, you can still use pieces of the Yocto Project for your development process. 543 If this is the case, you can still use pieces of the Yocto Project for your development process.
544 However, because the process can vary greatly, this manual does not provide detail on the process. 544 However, because the process can vary greatly, this manual does not provide detail on the process.
545 </para> 545 </para>
@@ -597,7 +597,7 @@
597 </itemizedlist></para> 597 </itemizedlist></para>
598 <para>For information on pre-built kernel image naming schemes for images 598 <para>For information on pre-built kernel image naming schemes for images
599 that can run on the QEMU emulator, see the 599 that can run on the QEMU emulator, see the
600 "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" 600 "<ulink url='&YOCTO_DOCS_QS_URL;#downloading-the-pre-built-linux-kernel'>Downloading the Pre-Built Linux Kernel</ulink>"
601 section in the Yocto Project Quick Start.</para></listitem> 601 section in the Yocto Project Quick Start.</para></listitem>
602 <listitem><para><emphasis>Install the ADT</emphasis>: 602 <listitem><para><emphasis>Install the ADT</emphasis>:
603 The ADT provides a target-specific cross-development toolchain, the root filesystem, 603 The ADT provides a target-specific cross-development toolchain, the root filesystem,
@@ -635,7 +635,7 @@
635 Once your application is deployed, you need to test it. 635 Once your application is deployed, you need to test it.
636 Within the Eclipse IDE, you can use the debubbing environment along with the 636 Within the Eclipse IDE, you can use the debubbing environment along with the
637 set of user-space tools installed along with the ADT to debug your application. 637 set of user-space tools installed along with the ADT to debug your application.
638 Of course, the same user-space tools are available separately to use if you choose 638 Of course, the same user-space tools are available separately if you choose
639 not to use the Eclipse IDE.</para></listitem> 639 not to use the Eclipse IDE.</para></listitem>
640 </orderedlist> 640 </orderedlist>
641 </para> 641 </para>
@@ -646,7 +646,14 @@
646 646
647 <para> 647 <para>
648 The Eclipse IDE is a popular development environment and it fully supports 648 The Eclipse IDE is a popular development environment and it fully supports
649 development using the Yocto Project. 649 development using the Yocto Project.
650 <note>This release of the Yocto Project supports both the Juno and Indigo versions
651 of the Eclipse IDE.
652 Thus, the following information provides setup information for both versions.
653 </note>
654 </para>
655
656 <para>
650 When you install and configure the Eclipse Yocto Project Plug-in into 657 When you install and configure the Eclipse Yocto Project Plug-in into
651 the Eclipse IDE, you maximize your Yocto Project experience. 658 the Eclipse IDE, you maximize your Yocto Project experience.
652 Installing and configuring the Plug-in results in an environment that 659 Installing and configuring the Plug-in results in an environment that
@@ -686,9 +693,18 @@
686 <title>Installing the Eclipse IDE</title> 693 <title>Installing the Eclipse IDE</title>
687 694
688 <para> 695 <para>
689 It is recommended that you have the Indigo 3.7.2 version of the 696 It is recommended that you have the Juno 4.2 version of the
690 Eclipse IDE installed on your development system. 697 Eclipse IDE installed on your development system.
691 If you don’t have this version, you can find it at 698 However, if you currently have the Indigo 3.7.2 version installed and you do
699 not want to upgrade the IDE, you can configure Indigo to work with the
700 Yocto Project.
701 See the
702 "<link linkend='configuring-the-eclipse-ide-indigo'>Configuring the Eclipse IDE (Indigo)</link>"
703 section.
704 </para>
705
706 <para>
707 If you don’t have the Juno 4.2 Eclipse IDE installed, you can find the tarball at
692 <ulink url='&ECLIPSE_MAIN_URL;'></ulink>. 708 <ulink url='&ECLIPSE_MAIN_URL;'></ulink>.
693 From that site, choose the Eclipse Classic version particular to your development 709 From that site, choose the Eclipse Classic version particular to your development
694 host. 710 host.
@@ -704,22 +720,23 @@
704 into a clean directory using the default name <filename>eclipse</filename>: 720 into a clean directory using the default name <filename>eclipse</filename>:
705 <literallayout class='monospaced'> 721 <literallayout class='monospaced'>
706 $ cd ~ 722 $ cd ~
707 $ tar -xzvf ~/Downloads/eclipse-SDK-3.7.2-linux-gtk-x86_64.tar.gz 723 $ tar -xzvf ~/Downloads/eclipse-SDK-4.2-linux-gtk-x86_64.tar.gz
708 </literallayout> 724 </literallayout>
709 </para> 725 </para>
710 726
711 <para> 727 <para>
712 One issue exists that you need to be aware of regarding the Java 728 If you have the Indigo 3.7.2 Eclipse IDE already installed and you want to use that
729 version, one issue exists that you need to be aware of regarding the Java
713 Virtual machine’s garbage collection (GC) process. 730 Virtual machine’s garbage collection (GC) process.
714 The GC process does not clean up the permanent generation 731 The GC process does not clean up the permanent generation
715 space (PermGen). 732 space (PermGen).
716 This space stores metadata descriptions of classes. 733 This space stores metadata descriptions of classes.
717 The default value is set too small and it could trigger an 734 The default value is set too small and it could trigger an
718 out-of-memory error such as the following: 735 out-of-memory error such as the following:
719 <literallayout class='monospaced'> 736 <literallayout class='monospaced'>
720 Java.lang.OutOfMemoryError: PermGen space 737 Java.lang.OutOfMemoryError: PermGen space
721 </literallayout> 738 </literallayout>
722 </para> 739 </para>
723 740
724 <para> 741 <para>
725 This error causes the application to hang. 742 This error causes the application to hang.
@@ -727,20 +744,67 @@
727 744
728 <para> 745 <para>
729 To fix this issue, you can use the <filename>--vmargs</filename> 746 To fix this issue, you can use the <filename>--vmargs</filename>
730 option when you start Eclipse to increase the size of the permanent generation space: 747 option when you start the Indigo 3.7.2 Eclipse IDE
748 to increase the size of the permanent generation space:
731 <literallayout class='monospaced'> 749 <literallayout class='monospaced'>
732 eclipse --vmargs --XX:PermSize=256M 750 eclipse --vmargs --XX:PermSize=256M
733 </literallayout> 751 </literallayout>
734 </para> 752 </para>
735 </section> 753 </section>
736 754
737 <section id='configuring-the-eclipse-ide'> 755 <section id='configuring-the-eclipse-ide-juno'>
738 <title>Configuring the Eclipse IDE</title> 756 <title>Configuring the Eclipse IDE (Juno)</title>
757
758 <para>
759 This section presents the steps needed to configure the Juno 4.2 Eclipse IDE.
760 If you are using Indigo 3.7.2, see the
761 "<link linkend='configuring-the-eclipse-ide-indigo'>Configuring the Eclipse IDE (Indigo)</link>".
762 </para>
763
764 <para>
765 Before installing and configuring the Eclipse Yocto Plug-in, you need to configure
766 the Juno 4.2 Eclipse IDE.
767 Follow these general steps:
768 <orderedlist>
769 <listitem><para>Start the Eclipse IDE.</para></listitem>
770 <listitem><para>Make sure you are in your Workbench and select
771 "Install New Software" from the "Help" pull-down menu.
772 </para></listitem>
773 <listitem><para>Select <filename>Juno - &ECLIPSE_JUNO_URL;</filename>
774 from the "Work with:" pull-down menu.</para></listitem>
775 <listitem><para>Expand the box next to "Linux Tools" and select the
776 "LTTng - Linux Tracing Toolkit" boxes.</para></listitem>
777 <listitem><para>Expand the box next to "Mobile and Device Development" and select the
778 following boxes:
779 <itemizedlist>
780 <listitem><para><filename>C/C++ Remote Launch</filename></para></listitem>
781 <listitem><para><filename>Remote System Explorer End-user Runtime</filename></para></listitem>
782 <listitem><para><filename>Remote System Explorer User Actions</filename></para></listitem>
783 <listitem><para><filename>Target Management Terminal</filename></para></listitem>
784 <listitem><para><filename>TCF Remote System Explorer add-in</filename></para></listitem>
785 <listitem><para><filename>TCF Target Explorer</filename></para></listitem>
786 </itemizedlist></para></listitem>
787 <listitem><para>Expand the box next to <filename>Programming Languages</filename>
788 and select the <filename>Autotools Support for CDT</filename>
789 and <filename>C/C++ Development Tools</filename> boxes.</para></listitem>
790 <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem>
791 </orderedlist>
792 </para>
793 </section>
794
795 <section id='configuring-the-eclipse-ide-indigo'>
796 <title>Configuring the Eclipse IDE (Indigo)</title>
797
798 <para>
799 This section presents the steps needed to configure the Indigo 3.7.2 Eclipse IDE.
800 If you are using Juno 4.2, see the
801 "<link linkend='configuring-the-eclipse-ide-juno'>Configuring the Eclipse IDE (Juno)</link>".
802 </para>
739 803
740 <para> 804 <para>
741 Before installing and configuring the Eclipse Yocto Plug-in, you need to configure 805 Before installing and configuring the Eclipse Yocto Plug-in, you need to configure
742 the Eclipse IDE. 806 the Indigo 3.7.2 Eclipse IDE.
743 Follow these general steps to configure Eclipse: 807 Follow these general steps:
744 <orderedlist> 808 <orderedlist>
745 <listitem><para>Start the Eclipse IDE.</para></listitem> 809 <listitem><para>Start the Eclipse IDE.</para></listitem>
746 <listitem><para>Make sure you are in your Workbench and select 810 <listitem><para>Make sure you are in your Workbench and select