diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-06-14 09:52:03 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-06-15 11:26:47 +0100 |
commit | 79081fa07c63ca58dda840f46c295d04cce42aae (patch) | |
tree | a51b4d414e13d1bb17d28cbb8eed71f81475c026 /documentation | |
parent | 6caba4afb8e7ea1dbbe12c69632fd63b2aba0fc3 (diff) | |
download | poky-79081fa07c63ca58dda840f46c295d04cce42aae.tar.gz |
sdk-manual: Updates to Eclipse Workflow section
Updated the "Workflow Using Eclipse" section head to not match so
closely the "Working With Eclipse" section heading. TOC appeared
funny.
Also, updated the step 1 to be more accurate regarding the real
need of having a YP build host and where to go to get information
on setting it up.
(From yocto-docs rev: 1cbca098a2f793bd86b6f73d3d35ce79bdf639f0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/sdk-manual/sdk-eclipse-project.xml | 57 |
1 files changed, 43 insertions, 14 deletions
diff --git a/documentation/sdk-manual/sdk-eclipse-project.xml b/documentation/sdk-manual/sdk-eclipse-project.xml index 3eb85e8ab1..b1ebf54dd0 100644 --- a/documentation/sdk-manual/sdk-eclipse-project.xml +++ b/documentation/sdk-manual/sdk-eclipse-project.xml | |||
@@ -12,15 +12,34 @@ | |||
12 | application all from within Eclipse. | 12 | application all from within Eclipse. |
13 | This chapter describes general workflow using the SDK and Eclipse | 13 | This chapter describes general workflow using the SDK and Eclipse |
14 | and how to configure and set up Eclipse. | 14 | and how to configure and set up Eclipse. |
15 | <note><title>Notes</title> | ||
16 | <itemizedlist> | ||
17 | <listitem><para> | ||
18 | This chapter assumes development of applications on top of | ||
19 | an image prepared using the Yocto Project. | ||
20 | As such, inclusion of a pre-built image or the building of | ||
21 | an image is included in the workflow. | ||
22 | </para></listitem> | ||
23 | <listitem><para> | ||
24 | The chapter also assumes development on a build host that | ||
25 | is set up to use the Yocto Project. | ||
26 | Realize that you can easily use Eclipse and the Yocto | ||
27 | Project plug-in to develop an application for any number | ||
28 | of images developed and tested on different machines. | ||
29 | </para></listitem> | ||
30 | </itemizedlist> | ||
31 | </note> | ||
15 | </para> | 32 | </para> |
16 | 33 | ||
17 | <section id='workflow-using-eclipse'> | 34 | <section id='application-development-workflow-using-eclipse'> |
18 | <title>Workflow Using <trademark class='trade'>Eclipse</trademark></title> | 35 | <title>Application Development Workflow Using <trademark class='trade'>Eclipse</trademark></title> |
19 | 36 | ||
20 | <para> | 37 | <para> |
21 | The following figure and supporting list summarize the | 38 | The following figure and supporting list summarize a |
22 | general workflow for application development that uses the | 39 | general workflow for application development that uses the |
23 | SDK within the Eclipse IDE. | 40 | SDK within the Eclipse IDE. |
41 | The application developed runs on top of an image created using | ||
42 | the Yocto Project. | ||
24 | </para> | 43 | </para> |
25 | 44 | ||
26 | <para> | 45 | <para> |
@@ -32,20 +51,26 @@ | |||
32 | <orderedlist> | 51 | <orderedlist> |
33 | <listitem><para> | 52 | <listitem><para> |
34 | <emphasis>Prepare the Host System for the Yocto Project</emphasis>: | 53 | <emphasis>Prepare the Host System for the Yocto Project</emphasis>: |
54 | Because this example workflow assumes development on a | ||
55 | system set up to use the Yocto Project, you need to be | ||
56 | sure your | ||
57 | <ulink url='&YOCTO_DOCS_REF_URL;#hardware-build-system-term'>build host</ulink> | ||
58 | can use the Yocto Project. | ||
35 | See the | 59 | See the |
36 | "<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" | 60 | "<ulink url='&YOCTO_DOCS_DEV_URL;#setting-up-the-development-host-to-use-the-yocto-project'>Preparing a Build Host</ulink>" |
37 | and | 61 | section in the Yocto Project Development Tasks Manual for |
38 | "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" | 62 | information on how to set up your build host. |
39 | sections both in the Yocto Project Reference Manual for | 63 | <note> |
40 | requirements. | 64 | Be sure you install the "xterm" package, which is a |
41 | In particular, be sure your host system has the | 65 | <ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>graphical and Eclipse plug-in extra</ulink> |
42 | <filename>xterm</filename> package installed. | 66 | needed by Eclipse. |
67 | </note> | ||
43 | </para></listitem> | 68 | </para></listitem> |
44 | <listitem><para> | 69 | <listitem><para> |
45 | <emphasis>Secure the Yocto Project Kernel Target | 70 | <emphasis>Secure the Yocto Project Kernel Target Image</emphasis>: |
46 | Image</emphasis>: | ||
47 | You must have a target kernel image that has been built | 71 | You must have a target kernel image that has been built |
48 | using the OpenEmbedded build system.</para> | 72 | using the OpenEmbedded build system.</para> |
73 | |||
49 | <para>Depending on whether the Yocto Project has a | 74 | <para>Depending on whether the Yocto Project has a |
50 | pre-built image that matches your target architecture | 75 | pre-built image that matches your target architecture |
51 | and where you are going to run the image while you | 76 | and where you are going to run the image while you |
@@ -78,6 +103,9 @@ | |||
78 | "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#using-devtool-to-patch-the-kernel'>Using <filename>devtool</filename> to Patch the Kernel</ulink>" | 103 | "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#using-devtool-to-patch-the-kernel'>Using <filename>devtool</filename> to Patch the Kernel</ulink>" |
79 | section in the Yocto Project Linux Kernel | 104 | section in the Yocto Project Linux Kernel |
80 | Development Manual for an example. | 105 | Development Manual for an example. |
106 | You can also see the | ||
107 | "<ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage#Making_a_Suitable_Qemux86_Image'>Making a Suitable Qemux86 Image</ulink>" | ||
108 | wiki for steps needed to build the image for QEMU. | ||
81 | </para></listitem> | 109 | </para></listitem> |
82 | </itemizedlist> | 110 | </itemizedlist> |
83 | </para></listitem> | 111 | </para></listitem> |
@@ -91,10 +119,10 @@ | |||
91 | section. | 119 | section. |
92 | </para></listitem> | 120 | </para></listitem> |
93 | <listitem><para> | 121 | <listitem><para> |
94 | <emphasis>Secure the Target Root Filesystem | 122 | <emphasis>Secure the Target Root Filesystem and the Cross-Development Toolchain</emphasis>: |
95 | and the Cross-Development Toolchain</emphasis>: | ||
96 | You need to find and download the appropriate root | 123 | You need to find and download the appropriate root |
97 | filesystem and the cross-development toolchain.</para> | 124 | filesystem and the cross-development toolchain.</para> |
125 | |||
98 | <para>You can find the tarballs for the root filesystem | 126 | <para>You can find the tarballs for the root filesystem |
99 | in the same area used for the kernel image. | 127 | in the same area used for the kernel image. |
100 | Depending on the type of image you are running, the | 128 | Depending on the type of image you are running, the |
@@ -102,6 +130,7 @@ | |||
102 | For example, if you are developing an application that | 130 | For example, if you are developing an application that |
103 | runs on an image that supports Sato, you need to get a | 131 | runs on an image that supports Sato, you need to get a |
104 | root filesystem that supports Sato.</para> | 132 | root filesystem that supports Sato.</para> |
133 | |||
105 | <para>You can find the cross-development toolchains at | 134 | <para>You can find the cross-development toolchains at |
106 | <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'><filename>toolchains</filename></ulink>. | 135 | <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'><filename>toolchains</filename></ulink>. |
107 | Be sure to get the correct toolchain for your | 136 | Be sure to get the correct toolchain for your |