diff options
Diffstat (limited to 'poky/documentation/sdk-manual/sdk-eclipse-project.xml')
| -rw-r--r-- | poky/documentation/sdk-manual/sdk-eclipse-project.xml | 169 |
1 files changed, 99 insertions, 70 deletions
diff --git a/poky/documentation/sdk-manual/sdk-eclipse-project.xml b/poky/documentation/sdk-manual/sdk-eclipse-project.xml index 3eb85e8ab..f8a586f54 100644 --- a/poky/documentation/sdk-manual/sdk-eclipse-project.xml +++ b/poky/documentation/sdk-manual/sdk-eclipse-project.xml @@ -12,15 +12,34 @@ application all from within Eclipse. This chapter describes general workflow using the SDK and Eclipse and how to configure and set up Eclipse. + <note><title>Notes</title> + <itemizedlist> + <listitem><para> + This chapter assumes development of applications on top of + an image prepared using the Yocto Project. + As such, inclusion of a pre-built image or the building of + an image is included in the workflow. + </para></listitem> + <listitem><para> + The chapter also assumes development on a build host that + is set up to use the Yocto Project. + Realize that you can easily use Eclipse and the Yocto + Project plug-in to develop an application for any number + of images developed and tested on different machines. + </para></listitem> + </itemizedlist> + </note> </para> - <section id='workflow-using-eclipse'> - <title>Workflow Using <trademark class='trade'>Eclipse</trademark></title> + <section id='application-development-workflow-using-eclipse'> + <title>Application Development Workflow Using <trademark class='trade'>Eclipse</trademark></title> <para> - The following figure and supporting list summarize the + The following figure and supporting list summarize a general workflow for application development that uses the SDK within the Eclipse IDE. + The application developed runs on top of an image created using + the Yocto Project. </para> <para> @@ -32,22 +51,29 @@ <orderedlist> <listitem><para> <emphasis>Prepare the Host System for the Yocto Project</emphasis>: + Because this example workflow assumes development on a + system set up to use the Yocto Project, you need to be + sure your + <ulink url='&YOCTO_DOCS_REF_URL;#hardware-build-system-term'>build host</ulink> + can use the Yocto Project. See the - "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" - and - "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" - sections both in the Yocto Project Reference Manual for - requirements. - In particular, be sure your host system has the - <filename>xterm</filename> package installed. + "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Preparing a Build Host</ulink>" + section in the Yocto Project Development Tasks Manual for + information on how to set up your build host. + <note> + Be sure you install the "xterm" package, which is a + <ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>graphical and Eclipse plug-in extra</ulink> + needed by Eclipse. + </note> </para></listitem> <listitem><para> - <emphasis>Secure the Yocto Project Kernel Target - Image</emphasis>: - You must have a target kernel image that has been built - using the OpenEmbedded build system.</para> - <para>Depending on whether the Yocto Project has a - pre-built image that matches your target architecture + <emphasis>Secure the Yocto Project Kernel Target Image</emphasis>: + This example workflow assumes application development on + top of an image built using the Yocto Project. + Depending on whether you are using a pre-built image + that matches your target architecture or you are using an + image you build using the + <ulink url='&YOCTO_DOCS_REF_URL;#build-system-term'>OpenEmbedded Build System</ulink> and where you are going to run the image while you develop your application (QEMU or real hardware), the area from which you get the image differs. @@ -78,6 +104,10 @@ "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#using-devtool-to-patch-the-kernel'>Using <filename>devtool</filename> to Patch the Kernel</ulink>" section in the Yocto Project Linux Kernel Development Manual for an example. + You can also see the + "<ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage#Making_a_Suitable_Qemux86_Image'>Making a Suitable Qemux86 Image</ulink>" + wiki for steps needed to build an image suitable + for QEMU and for debugging within the Eclipse IDE. </para></listitem> </itemizedlist> </para></listitem> @@ -91,10 +121,10 @@ section. </para></listitem> <listitem><para> - <emphasis>Secure the Target Root Filesystem - and the Cross-Development Toolchain</emphasis>: + <emphasis>Secure the Target Root Filesystem and the Cross-Development Toolchain</emphasis>: You need to find and download the appropriate root filesystem and the cross-development toolchain.</para> + <para>You can find the tarballs for the root filesystem in the same area used for the kernel image. Depending on the type of image you are running, the @@ -102,6 +132,7 @@ For example, if you are developing an application that runs on an image that supports Sato, you need to get a root filesystem that supports Sato.</para> + <para>You can find the cross-development toolchains at <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'><filename>toolchains</filename></ulink>. Be sure to get the correct toolchain for your @@ -124,8 +155,7 @@ </para></listitem> <listitem><para> <emphasis>Create and Build Your Application</emphasis>: - At this point, you need to have source files for your - application. + You need to have source files for your application. Once you have the files, you can use the Eclipse IDE to import them and build the project. </para></listitem> @@ -270,6 +300,17 @@ "Launch" button. You should see the Eclipse welcome page from which can click "workbench" to enter your workspace. + <note> + The executable for Eclipse is located in the + <filename>eclipse/cpp-oxygen/eclipse</filename> + folder. + To launch Eclipse outside of the installation + process, simply execute that binary. + Here is an example: + <literallayout class='monospaced'> + $ ~/eclipse/cpp-oxygen/eclipse/eclipse + </literallayout> + </note> </para></listitem> </orderedlist> </para> @@ -284,13 +325,13 @@ <itemizedlist> <listitem><para> Depending on how you installed Eclipse and what - you have already done, some of the options will + you have already done, some of the options do not appear. If you cannot find an option as directed by the manual, it has already been installed. </para></listitem> <listitem><para> - If you want to see all items regardless of + If you want to see all options regardless of whether they are installed or not, deselect the "Hide items that are already installed" check box. @@ -555,7 +596,7 @@ </section> <section id='oxygen-configuring-the-eclipse-yocto-plug-in'> - <title>Configuring the Oxygen Eclipse Yocto Plug-in</title> + <title>Configuring the Oxygen Eclipse Yocto Plug-In</title> <para> Configuring the Oxygen Eclipse Yocto Plug-in involves @@ -604,18 +645,13 @@ architecture. <itemizedlist> <listitem><para> - <emphasis>Selecting the Toolchain - Type:</emphasis> - Choose between - <filename>Standalone pre-built toolchain</filename> - and - <filename>Build system derived toolchain</filename> - for Cross Compiler Options. + <emphasis>Selecting the Toolchain Type:</emphasis> + Choose between "Standalone pre-built toolchain" + and "Build system derived toolchain" for + Cross Compiler Options. <itemizedlist> <listitem><para> - <emphasis> - <filename>Standalone Pre-built Toolchain:</filename> - </emphasis> + <emphasis>Standalone Pre-built Toolchain:</emphasis> Select this type when you are using a stand-alone cross-toolchain. For example, suppose you are an @@ -630,29 +666,24 @@ for an existing image. </para></listitem> <listitem><para> - <emphasis> - <filename>Build System Derived Toolchain:</filename> - </emphasis> + <emphasis>Build System Derived Toolchain:</emphasis> Select this type if you built the toolchain as part of the <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. - When you select - <filename>Build system derived toolchain</filename>, - you are using the toolchain built - and bundled inside the Build + When you select "Build system derived + toolchain", you are using the toolchain + built and bundled inside the Build Directory. For example, suppose you created a suitable image using the steps in the <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. In this situation, you would select - the - <filename>Build system derived toolchain</filename>. + "Build system derived toolchain". </para></listitem> </itemizedlist> </para></listitem> <listitem><para> - <emphasis>Specify the Toolchain Root - Location:</emphasis> + <emphasis>Specify the Toolchain Root Location:</emphasis> If you are using a stand-alone pre-built toolchain, you should be pointing to where it is installed (e.g. @@ -661,11 +692,10 @@ "<link linkend='sdk-installing-the-sdk'>Installing the SDK</link>" section for information about how the SDK is installed.</para> + <para>If you are using a build system derived toolchain, the path you provide for - the - <filename>Toolchain Root Location</filename> - field is the + the "Toolchain Root Location" field is the <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> from which you run the <filename>bitbake</filename> command (e.g @@ -676,11 +706,11 @@ section. </para></listitem> <listitem><para> - <emphasis>Specify Sysroot Location: - </emphasis> + <emphasis>Specify Sysroot Location:</emphasis> This location is where the root filesystem for the target hardware resides. </para> + <para>This location depends on where you separately extracted and installed the target filesystem when you either built @@ -702,6 +732,7 @@ directory (e.g. <filename>/home/scottrif/poky/build/MY_QEMU_ROOTFS</filename>). </para> + <para>For more information on how to install the toolchain and on how to extract and install the sysroot filesystem, see the @@ -709,12 +740,10 @@ section. </para></listitem> <listitem><para> - <emphasis>Select the Target Architecture: - </emphasis> + <emphasis>Select the Target Architecture:</emphasis> The target architecture is the type of hardware you are going to use or emulate. - Use the pull-down - <filename>Target Architecture</filename> + Use the pull-down "Target Architecture" menu to make your selection. The pull-down menu should have the supported architectures. @@ -747,10 +776,10 @@ If you are using the emulator, you also need to locate the kernel and specify any custom options.</para> - <para>If you selected the - <filename>Build system derived toolchain</filename>, - the target kernel you built will be located - in the + + <para>If you selected the Build system derived + toolchain, the target kernel you built will be + located in the <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> in <filename>tmp/deploy/images/<replaceable>machine</replaceable></filename> @@ -762,11 +791,13 @@ Directory path followed by the image (e.g. <filename>/home/scottrif/poky/build/tmp/deploy/images/qemux86/bzImage-qemux86.bin</filename>). </para> + <para>If you selected the standalone pre-built toolchain, the pre-built image you downloaded is located in the directory you specified when you downloaded the image.</para> + <para>Most custom options are for advanced QEMU users to further customize their QEMU instance. @@ -785,18 +816,17 @@ The following is an example: <literallayout class='monospaced'> serial ‘<-m 256 -full-screen>’ - </literallayout></para> - <para> + </literallayout> Regardless of the mode, Sysroot is already defined as part of the Cross-Compiler - Options configuration in the - <filename>Sysroot Location:</filename> - field. + Options configuration in the "Sysroot + Location:" field. </para></listitem> <listitem><para> <emphasis>External HW:</emphasis> Select this option if you will be using - actual hardware.</para></listitem> + actual hardware. + </para></listitem> </itemizedlist> </para> @@ -849,7 +879,7 @@ <listitem><para> Put a name in the "Project name:" field. Do not use hyphens as part of the name - (e.g. <filename>hello</filename>). + (e.g. "hello"). </para></listitem> <listitem><para> Click "Next". @@ -1080,7 +1110,7 @@ </para></listitem> <listitem><para> In the left area, expand - <filename>C/C++Remote Application</filename>. + "C/C++Remote Application". </para></listitem> <listitem><para> Locate your project and select it to bring @@ -1099,7 +1129,7 @@ <listitem><para> Create a new connection to the QEMU instance by clicking on "new".</para></listitem> - <listitem><para>Select <filename>SSH</filename>, which + <listitem><para>Select "SSH", which means Secure Socket Shell and then click "OK". Optionally, you can select a TCF connection instead. @@ -1111,11 +1141,10 @@ <listitem><para> Put the IP address for the connection in the "Host" field. - For QEMU, the default is - <filename>192.168.7.2</filename>. + For QEMU, the default is "192.168.7.2". However, if a previous QEMU session did not exit cleanly, the IP address increments (e.g. - <filename>192.168.7.3</filename>). + "192.168.7.3"). <note> You can find the IP address for the current QEMU session by looking in the xterm that @@ -1123,7 +1152,7 @@ </note> </para></listitem> <listitem><para> - Enter <filename>root</filename>, which + Enter "root", which is the default for QEMU, for the "User" field. Be sure to leave the password field empty. </para></listitem> |
