diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-09-09 09:38:02 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-09-13 21:48:37 +0100 |
commit | 0bd5bba8ab535574b1bce9e20b52a1cb02f81a2b (patch) | |
tree | f1ce20a41f13a4d5a29ac752dae2db0ba997d1ac /documentation/adt-manual | |
parent | 826a53adf65aaf709383b8b8caed7b99d20f8909 (diff) | |
download | poky-0bd5bba8ab535574b1bce9e20b52a1cb02f81a2b.tar.gz |
documentation/adt-manual: Rewrite for Indigo version of Eclipse.
These edits are extensive and cross into two files: adt-prepare.xml
and adt-eclipse.xml. This is the first pass of a large re-write
to bring the examples up-to-date using the preferred version of
the Eclipse IDE (Indego 3.7). Much has changed.
(From yocto-docs rev: 57c1f905c6d66268a498e013193d003596f2303d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/adt-manual')
-rw-r--r-- | documentation/adt-manual/adt-eclipse.xml | 365 | ||||
-rw-r--r-- | documentation/adt-manual/adt-prepare.xml | 16 |
2 files changed, 212 insertions, 169 deletions
diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml index dee8e1fb1a..3275c18cbd 100644 --- a/documentation/adt-manual/adt-eclipse.xml +++ b/documentation/adt-manual/adt-eclipse.xml | |||
@@ -29,30 +29,36 @@ | |||
29 | <para> | 29 | <para> |
30 | To develop within the Eclipse IDE, you need to do the following: | 30 | To develop within the Eclipse IDE, you need to do the following: |
31 | <orderedlist> | 31 | <orderedlist> |
32 | <listitem><para>Be sure the optimal version of Eclipse IDE | 32 | <listitem><para>Be sure the optimal version of the Eclipse IDE |
33 | is installed.</para></listitem> | 33 | is installed.</para></listitem> |
34 | <listitem><para>Install the Eclipse Plug-in requirements prior to installing | 34 | <listitem><para>Configure the Eclipse IDE.</para></listitem> |
35 | the Eclipse Yocto Plug-in.</para></listitem> | 35 | <listitem><para>Install the Eclipse Yocto Plug-in.</para></listitem> |
36 | <listitem><para>Configure the Eclipse Yocto Plug-in.</para></listitem> | 36 | <listitem><para>Configure the Eclipse Yocto Plug-in.</para></listitem> |
37 | </orderedlist> | 37 | </orderedlist> |
38 | </para> | 38 | </para> |
39 | 39 | ||
40 | <section id='installing-eclipse-ide'> | 40 | <section id='installing-eclipse-ide'> |
41 | <title>Installing Eclipse IDE</title> | 41 | <title>Installing the Eclipse IDE</title> |
42 | 42 | ||
43 | <para> | 43 | <para> |
44 | It is recommended that you have the Indigo 3.7 version of the | 44 | It is recommended that you have the Indigo 3.7 version of the |
45 | Eclipse IDE installed on your development system. | 45 | Eclipse IDE installed on your development system. |
46 | If you don’t have this version, you can find it at | 46 | If you don’t have this version, you can find it at |
47 | <ulink url='http://www.eclipse.org/downloads'></ulink>. | 47 | <ulink url='http://www.eclipse.org/downloads'></ulink>. |
48 | From that site, choose the Eclipse Classic version. | 48 | From that site, choose the Eclipse Classic version particular to your development |
49 | host. | ||
49 | This version contains the Eclipse Platform, the Java Development | 50 | This version contains the Eclipse Platform, the Java Development |
50 | Tools (JDT), and the Plug-in Development Environment. | 51 | Tools (JDT), and the Plug-in Development Environment. |
51 | </para> | 52 | </para> |
52 | 53 | ||
53 | <para> | 54 | <para> |
54 | Once you have downloaded the tarball, extract it into a clean | 55 | Once you have downloaded the tarball, extract it into a clean |
55 | directory and complete the installation. | 56 | directory. |
57 | For example, the following command unpacks and installs the Eclipse IDE | ||
58 | into a clean directory named <filename>eclipse</filename>: | ||
59 | <literallayout class='monospaced'> | ||
60 | $ tar -xzvf ~/Downloads/Eclipse-SDK-3.7-linux-gtk-x86_64.tar.gz | ||
61 | </literallayout> | ||
56 | </para> | 62 | </para> |
57 | 63 | ||
58 | <para> | 64 | <para> |
@@ -81,72 +87,97 @@ | |||
81 | </para> | 87 | </para> |
82 | </section> | 88 | </section> |
83 | 89 | ||
84 | <section id='installing-required-plug-ins-and-the-eclipse-yocto-plug-in'> | 90 | <section id='configuring-the-eclipse-ide'> |
85 | <title>Installing Required Plug-ins and the Eclipse Yocto Plug-in</title> | 91 | <title>Configuring the Eclipse IDE</title> |
86 | 92 | ||
87 | <para> | 93 | <para> |
88 | Before installing the Yocto Plug-in, you need to be sure that the | 94 | Before installing and configuring the Eclipse Yocto Plug-in, you need to configure |
89 | <filename>CDT 8.0</filename>, <filename>RSE 3.2</filename>, and | 95 | the Eclipse IDE. |
90 | <filename>Autotools</filename> plug-ins are all installed in the | 96 | Follow these general steps to configure Eclipse: |
91 | following order. | ||
92 | After installing these three plug-ins, you can install the Eclipse Yocto Plug-in. | ||
93 | Use the following URLs for the plug-ins: | ||
94 | <orderedlist> | 97 | <orderedlist> |
95 | <listitem><para><emphasis> | 98 | <listitem><para>Start the Eclipse IDE.</para></listitem> |
96 | <ulink url='http://download.eclipse.org/tools/cdt/releases/indigo/'>CDT 8.0:</ulink> | 99 | <listitem><para>Select "Install New Software" from the "Help" pull-down menu. |
97 | </emphasis> For <filename>CDT main features</filename>, select the | 100 | </para></listitem> |
98 | checkbox so you get all items. | 101 | <listitem><para>Select <filename>Indego - http://download.eclipse.org/releases/indego</filename> |
99 | For <filename>CDT optional features</filename> expand the selections and check | 102 | from the "Work with:" pull-down menu.</para></listitem> |
100 | <filename>C/C++ Remote Launch</filename>.</para></listitem> | 103 | <listitem><para>Expand the box next to <filename>Programming Languages</filename> |
101 | <listitem><para><emphasis> | 104 | and select the <filename>Autotools Support for CDT (incubation)</filename> |
102 | <ulink url='http://download.eclipse.org/tm/updates/3.2'>RSE 3.2:</ulink></emphasis> | 105 | and <filename>C/C++ Development Tools</filename> boxes.</para></listitem> |
103 | Check the box next to <filename>TM and RSE Main Features</filename> so you select all | 106 | <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> |
104 | those items. | 107 | <listitem><para>Select "Install New Software" from the "Help" pull-down menu.</para></listitem> |
105 | Note that all items in the main features depend on 3.2.1 version. | 108 | <listitem><para>After the Eclipse IDE restarts, click the |
106 | Expand the items under <filename>TM and RSE Uncategorized 3.2.1</filename> and | 109 | "Available Software Sites" link.</para></listitem> |
107 | select the following: <filename>Remote System Explorer End-User Runtime</filename>, | 110 | <listitem><para>Check the box next to |
108 | <filename>Remote System Explorer Extended SDK</filename>, | 111 | <filename>http://download.eclipse.org/tm/updates/3.3</filename> |
109 | <filename>Remote System Explorer User Actions</filename>, | 112 | and click "OK".</para></listitem> |
110 | <filename>RSE Core</filename>, <filename>RSE Terminals UI</filename>, | 113 | <listitem><para>Select <filename>http://download.eclipse.org/tm/updates/3.3</filename> |
111 | and <filename>Target Management Terminal</filename>.</para></listitem> | 114 | from the "Work with:" pull-down menu.</para></listitem> |
112 | <listitem><para><emphasis> | 115 | <listitem><para>Check the box next to <filename>TM and RSE Main Features</filename>. |
113 | <ulink url='http://download.eclipse.org/technology/linuxtools/update/'>Autotools:</ulink> | 116 | </para></listitem> |
114 | </emphasis> Expand the items under “Linux Tools” and select “Autotools support for | 117 | <listitem><para>Expand the box next to <filename>TM and RSE Optional Add-ons</filename> |
115 | CDT (Incubation)”.</para></listitem> | 118 | and select every item except <filename>RSE Unit Tests</filename> and |
116 | <listitem><para><emphasis> | 119 | <filename>RSE WinCE Services (incubation)</filename>.</para></listitem> |
117 | <ulink url='http://www.yoctoproject.org/downloads/eclipse-plugin/1.1'>Yocto Plug-in: | 120 | <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> |
118 | </ulink></emphasis> Check the box next to | 121 | <listitem><para>After the Eclipse IDE restarts, click the |
119 | <filename>Development tools & SDKs for Yocto Linux</filename> | 122 | "Available Software Sites" link.</para></listitem> |
120 | to select all the items.</para></listitem> | 123 | <listitem><para>Check the box next to |
124 | <filename>http://download.eclipse.org/tools/cdt/releases/indego</filename> | ||
125 | and click "OK".</para></listitem> | ||
126 | <listitem><para>Select <filename>http://download.eclipse.org/tools/cdt/releases/indego</filename> | ||
127 | from the "Work with:" pull-down menu.</para></listitem> | ||
128 | <listitem><para>Check the box next to <filename>CDT Main Features</filename>. | ||
129 | </para></listitem> | ||
130 | <listitem><para>Expand the box next to <filename>CDT Optional Features</filename> | ||
131 | and select <filename>C/C++ Remote Launch</filename> and | ||
132 | <filename>Target Communication Framework (incubation)</filename>.</para></listitem> | ||
133 | <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> | ||
121 | </orderedlist> | 134 | </orderedlist> |
122 | </para> | 135 | </para> |
136 | </section> | ||
137 | |||
138 | <section id='installing-the-eclipse-yocto-plug-in'> | ||
139 | <title>Installing the Eclipse Yocto Plug-in</title> | ||
123 | 140 | ||
124 | <para> | 141 | <para> |
125 | Follow these general steps to install an Eclipse plug-in: | 142 | To install the Eclipse Yocto Plug-in, follow these special steps. |
143 | The steps are WIP and are not final. | ||
144 | Once they are final they will be replaced with the actual steps: | ||
126 | <orderedlist> | 145 | <orderedlist> |
127 | <listitem><para>From within the Eclipse IDE, select the | 146 | <listitem><para>Open a shell and create a Git repository with: |
128 | <filename>Install New Software</filename> item from the <filename>Help</filename> | 147 | <literallayout class='monospaced'> |
129 | menu.</para></listitem> | 148 | $ git clone git://git.yoctoproject.org/yocto-eclipse yocto-eclipse |
130 | <listitem><para>Click <filename>Add…</filename> in the | 149 | </literallayout></para></listitem> |
131 | <filename>Work with:</filename> area.</para></listitem> | 150 | <listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem> |
132 | <listitem><para>Enter the URL for the repository and leave the <filename>Name</filename> | 151 | <listitem><para>Expand the "General" box and pick "existing projects into workspace". |
133 | field blank.</para></listitem> | 152 | </para></listitem> |
134 | <listitem><para>Check the boxes next to the software you need to | 153 | <listitem><para>Select the root directory and browse to "~/yocto-eclipse/plugins". |
135 | install and then complete the installation. | 154 | </para></listitem> |
136 | For information on the specific software packages you need to include, | 155 | <listitem><para>There will be three things there. |
137 | see the previous list.</para></listitem> | 156 | Select each one and install one at a time. |
157 | Do all three.</para></listitem> | ||
158 | <listitem><para>Restart everything.</para></listitem> | ||
138 | </orderedlist> | 159 | </orderedlist> |
139 | </para> | 160 | </para> |
161 | |||
162 | <para> | ||
163 | At this point I should be able to invoke Eclipse from the shell using the following: | ||
164 | <literallayout class='monospaced'> | ||
165 | $ cd ~/eclipse | ||
166 | $ ./eclipse -vmargs -XX:PermSize=256M | ||
167 | </literallayout> | ||
168 | What is shown is the default projects in the left pane. | ||
169 | I should be able to right-click on one of these and run as an Eclipse application to | ||
170 | bring up the Eclipse instance again with the Eclipse Yocto Plug-in working. | ||
171 | </para> | ||
140 | </section> | 172 | </section> |
141 | 173 | ||
142 | <section id='configuring-the-plug-in'> | 174 | <section id='configuring-the-eclipse-yocto-plug-in'> |
143 | <title>Configuring the Plug-in</title> | 175 | <title>Configuring the Eclipse Yocto Plug-in</title> |
144 | 176 | ||
145 | <para> | 177 | <para> |
146 | Configuring the Eclipse Yocto Plug-in involves choosing the Cross | 178 | Configuring the Eclipse Yocto Plug-in involves setting the Cross |
147 | Compiler Options, selecting the Target Architecture, and choosing | 179 | Compiler options and the Target options. |
148 | the Target Options. | 180 | The configurations you choose become the default settings for all projects. |
149 | The settings you choose become the default settings for all projects. | ||
150 | You do have opportunities to change them later when | 181 | You do have opportunities to change them later when |
151 | you configure the project (see the following section). | 182 | you configure the project (see the following section). |
152 | </para> | 183 | </para> |
@@ -156,7 +187,7 @@ | |||
156 | <itemizedlist> | 187 | <itemizedlist> |
157 | <listitem><para>Choose <filename>Windows -> Preferences</filename> to display | 188 | <listitem><para>Choose <filename>Windows -> Preferences</filename> to display |
158 | the Preferences Dialog</para></listitem> | 189 | the Preferences Dialog</para></listitem> |
159 | <listitem><para>Click <filename>Yocto SDK</filename></para></listitem> | 190 | <listitem><para>Click <filename>Yocto ADT</filename></para></listitem> |
160 | </itemizedlist> | 191 | </itemizedlist> |
161 | </para> | 192 | </para> |
162 | 193 | ||
@@ -164,86 +195,90 @@ | |||
164 | <title>Configuring the Cross-Compiler Options</title> | 195 | <title>Configuring the Cross-Compiler Options</title> |
165 | 196 | ||
166 | <para> | 197 | <para> |
167 | Choose between <filename>Stand-alone Prebuilt Toolchain</filename> | 198 | To configure the Cross Compiler Options, you must select the type of toolchain, |
168 | and <filename>Build System Derived Toolchain</filename> for Cross | 199 | point to the toolchain, specify the sysroot location, and select the target architecture. |
169 | Compiler Options. | ||
170 | <itemizedlist> | 200 | <itemizedlist> |
171 | <listitem><para><emphasis><filename>Stand-alone Prebuilt Toolchain:</filename></emphasis> | 201 | <listitem><para><emphasis>Selecting the Toolchain Type:</emphasis> |
172 | Select this mode | 202 | Choose between <filename>Standalone pre-built toolchain</filename> |
173 | when you are not concerned with building a target image or you do not have | 203 | and <filename>Build system derived toolchain</filename> for Cross |
174 | a Yocto Project build tree on your development system. | 204 | Compiler Options. |
175 | For example, suppose you are an application developer and do not | 205 | <itemizedlist> |
176 | need to build a target image. | 206 | <listitem><para><emphasis> |
177 | Instead, you just want to use an architecture-specific toolchain on an | 207 | <filename>Standalone Pre-built Toolchain:</filename></emphasis> |
178 | existing kernel and target root filesystem. | 208 | Select this mode when you are using a stand-alone cross-toolchain. |
179 | When you use <filename>Stand-alone Prebuilt Toolchain</filename>, | 209 | For example, suppose you are an application developer and do not |
180 | you are using the toolchain installed | 210 | need to build a target image. |
181 | in the <filename>/opt/poky</filename> directory.</para></listitem> | 211 | Instead, you just want to use an architecture-specific toolchain on an |
182 | <listitem><para><emphasis><filename>Build System Derived Toolchain:</filename></emphasis> | 212 | existing kernel and target root filesystem. |
183 | Select this mode | 213 | </para></listitem> |
184 | if you are building images for target hardware or your | 214 | <listitem><para><emphasis> |
185 | development environment already has a Yocto Project build tree. | 215 | <filename>Build System Derived Toolchain:</filename></emphasis> |
186 | In this case, you likely already have a Yocto Project build tree on | 216 | Select this mode if the cross-toolchain has been installed and built |
187 | your system or you (or someone else) will be building one. | 217 | as part of the Yocto Project build tree. |
188 | When you select <filename>Build System Derived Toolchain</filename>, | 218 | When you select <filename>Build system derived toolchain</filename>, |
189 | you are using the toolchain bundled | 219 | you are using the toolchain bundled |
190 | inside the Yocto Project build tree. | 220 | inside the Yocto Project build tree. |
191 | If you use this mode, you must also supply the Yocto Project build directory | 221 | </para></listitem> |
192 | in the <filename>Preferences Dialog</filename>.</para></listitem> | 222 | </itemizedlist> |
223 | </para></listitem> | ||
224 | <listitem><para><emphasis>Point to the Toolchain:</emphasis> | ||
225 | If you are using a stand-alone pre-built toolchain, you should be pointing to the | ||
226 | <filename>/opt/poky/$SDKVERSION</filename> directory. | ||
227 | This is the location for toolchains installed by the ADT Installer or by hand. | ||
228 | Sections <link linkend='configuring-and-running-the-adt-installer-script'> | ||
229 | Configuring and Running the ADT Installer Script</link> and | ||
230 | <link linkend='using-an-existing-toolchain-tarball'> | ||
231 | Using a Cross-Toolchain Tarball</link> describe two ways to install | ||
232 | a stand-alone cross-toolchain in the | ||
233 | <filename>/opt/poky</filename> directory. | ||
234 | <note>It is possible to install a stand-alone cross-toolchain in a directory | ||
235 | other than <filename>/opt/poky</filename>. | ||
236 | However, doing so is discouraged.</note></para> | ||
237 | <para>If you are using a system-derived toolchain, the path you provide | ||
238 | for the <filename>Toolchain Root Location</filename> | ||
239 | field is the Yocto Project's build directory. | ||
240 | See section <link linkend='using-the-toolchain-from-within-the-build-tree'> | ||
241 | Using BitBake and the Yocto Project Build Tree</link> for | ||
242 | information on how to install the toolchain into the Yocto | ||
243 | Project build tree.</para></listitem> | ||
244 | <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> | ||
245 | This location is where the root filesystem for the | ||
246 | target hardware is created on the development system by the ADT Installer. | ||
247 | The QEMU user-space tools, the | ||
248 | NFS boot process, and the cross-toolchain all use the sysroot location. | ||
249 | </para></listitem> | ||
250 | <listitem><para><emphasis>Select the Target Architecture:</emphasis> | ||
251 | The target architecture is the type of hardware you are | ||
252 | going to use or emulate. | ||
253 | Use the pull-down <filename>Target Architecture</filename> menu to make | ||
254 | your selection. | ||
255 | The pull-down menu should have the supported architectures. | ||
256 | If the architecture you need is not listed in the menu, you | ||
257 | will need to build the image. | ||
258 | See the | ||
259 | <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html#building-image'> Building an Image</ulink> section of the | ||
260 | <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html'> | ||
261 | The Yocto Project Quick Start</ulink> for more information.</para></listitem> | ||
193 | </itemizedlist> | 262 | </itemizedlist> |
194 | </para> | 263 | </para> |
195 | </section> | 264 | </section> |
196 | 265 | ||
197 | <section id='configuring-the-sysroot'> | 266 | <section id='configuring-the-target-options'> |
198 | <title>Configuring the Sysroot</title> | 267 | <title>Configuring the Target Options</title> |
199 | |||
200 | <para> | ||
201 | Specify the sysroot location, which is where the root filesystem for the | ||
202 | target hardware is created on the development system by the ADT Installer. | ||
203 | The QEMU user-space tools, the | ||
204 | NFS boot process, and the cross-toolchain all use the sysroot location | ||
205 | regardless of whether you select | ||
206 | (<filename>Stand-alone Prebuilt Toolchain</filename> or | ||
207 | <filename>Build System Derived Toolchain</filename>). | ||
208 | </para> | ||
209 | </section> | ||
210 | |||
211 | <section id='selecting-the-target-architecture'> | ||
212 | <title>Selecting the Target Architecture</title> | ||
213 | |||
214 | <para> | ||
215 | Use the pull-down <filename>Target Architecture</filename> menu and select the | ||
216 | target architecture. | ||
217 | </para> | ||
218 | |||
219 | <para> | ||
220 | The target architecture is the type of hardware you are | ||
221 | going to use or emulate. | ||
222 | This pull-down menu should have the supported architectures. | ||
223 | If the architecture you need is not listed in the menu, you | ||
224 | will need to re-visit the section "<link linkend='adt-prepare'>Preparing to Use | ||
225 | the Application Development Toolkit (ADT)</link>" earlier in this document. | ||
226 | </para> | ||
227 | </section> | ||
228 | |||
229 | <section id='choosing-the-target-options'> | ||
230 | <title>Choosing the Target Options</title> | ||
231 | 268 | ||
232 | <para> | 269 | <para> |
233 | You can choose to emulate hardware using the QEMU emulator, or you | 270 | You can choose to emulate hardware using the QEMU emulator, or you |
234 | can choose to use actual hardware. | 271 | can choose to run your image on actual hardware. |
235 | <itemizedlist> | 272 | <itemizedlist> |
236 | <listitem><para><emphasis><filename>External HW:</filename></emphasis> Select this option | ||
237 | if you will be using actual hardware.</para></listitem> | ||
238 | <listitem><para><emphasis><filename>QEMU:</filename></emphasis> Select this option if | 273 | <listitem><para><emphasis><filename>QEMU:</filename></emphasis> Select this option if |
239 | you will be using the QEMU emulator. | 274 | you will be using the QEMU emulator. |
240 | If you are using the emulator, you also need to locate the kernel | 275 | If you are using the emulator, you also need to locate the kernel |
241 | and specify any custom options.</para> | 276 | and specify any custom options.</para> |
242 | <para>If you select <filename>Build System Derived Toolchain</filename>, | 277 | <para>If you selected <filename>Build system derived toolchain</filename>, |
243 | the target kernel you built will be located in the | 278 | the target kernel you built will be located in the |
244 | Yocto Project build tree in <filename>tmp/deploy/images</filename> directory. | 279 | Yocto Project build tree in <filename>tmp/deploy/images</filename> directory. |
245 | If you select <filename>Stand-alone Prebuilt Toolchain</filename>, the | 280 | If you selected <filename>Standalone pre-built toolchain</filename>, the |
246 | pre-built kernel you downloaded is located | 281 | pre-built image you downloaded is located |
247 | in the directory you specified when you downloaded the image.</para> | 282 | in the directory you specified when you downloaded the image.</para> |
248 | <para>Most custom options are for advanced QEMU users to further | 283 | <para>Most custom options are for advanced QEMU users to further |
249 | customize their QEMU instance. | 284 | customize their QEMU instance. |
@@ -259,8 +294,11 @@ | |||
259 | serial ‘<-m 256 -full-screen>’ | 294 | serial ‘<-m 256 -full-screen>’ |
260 | </literallayout></para> | 295 | </literallayout></para> |
261 | <para> | 296 | <para> |
262 | Regardless of the mode, Sysroot is already defined in the “Sysroot” | 297 | Regardless of the mode, Sysroot is already defined as part of the |
263 | field.</para></listitem> | 298 | Cross Compiler Options configuration in the |
299 | <filename>Sysroot Location:</filename> field.</para></listitem> | ||
300 | <listitem><para><emphasis><filename>External HW:</filename></emphasis> Select this option | ||
301 | if you will be using actual hardware.</para></listitem> | ||
264 | </itemizedlist> | 302 | </itemizedlist> |
265 | </para> | 303 | </para> |
266 | 304 | ||
@@ -276,9 +314,9 @@ | |||
276 | 314 | ||
277 | <para> | 315 | <para> |
278 | You can create two types of projects: Autotools-based, or Makefile-based. | 316 | You can create two types of projects: Autotools-based, or Makefile-based. |
279 | This section describes how to create autotools-based projects from within | 317 | This section describes how to create Autotools-based projects from within |
280 | the Eclipse IDE. | 318 | the Eclipse IDE. |
281 | For information on creating Makefile-based projects in a terminal window see the section | 319 | For information on creating Makefile-based projects in a terminal window, see the section |
282 | "<link linkend='using-the-command-line'>Using the Command Line</link>". | 320 | "<link linkend='using-the-command-line'>Using the Command Line</link>". |
283 | </para> | 321 | </para> |
284 | 322 | ||
@@ -289,21 +327,21 @@ | |||
289 | <listitem><para>Select <filename>File -> New -> Project</filename>.</para></listitem> | 327 | <listitem><para>Select <filename>File -> New -> Project</filename>.</para></listitem> |
290 | <listitem><para>Double click <filename>CC++</filename>.</para></listitem> | 328 | <listitem><para>Double click <filename>CC++</filename>.</para></listitem> |
291 | <listitem><para>Double click <filename>C Project</filename> to create the project.</para></listitem> | 329 | <listitem><para>Double click <filename>C Project</filename> to create the project.</para></listitem> |
292 | <listitem><para>Double click <filename>Yocto SDK Project</filename>.</para></listitem> | 330 | <listitem><para>Expand <filename>Yocto ADT Project</filename>.</para></listitem> |
293 | <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>. | 331 | <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>. |
294 | This is an Autotools-based project based on a Yocto Project template.</para></listitem> | 332 | This is an Autotools-based project based on a Yocto Project template.</para></listitem> |
295 | <listitem><para>Put a name in the <filename>Project name:</filename> field.</para></listitem> | 333 | <listitem><para>Put a name in the <filename>Project name:</filename> field. |
334 | Do not use hyphens as part of the name.</para></listitem> | ||
296 | <listitem><para>Click <filename>Next</filename>.</para></listitem> | 335 | <listitem><para>Click <filename>Next</filename>.</para></listitem> |
297 | <listitem><para>Add information in the <filename>Author</filename> field.</para></listitem> | 336 | <listitem><para>Add information in the <filename>Author</filename> and |
298 | <listitem><para>Use <filename>GNU General Public License v2.0</filename> | 337 | <filename>Copyright notice</filename> fields.</para></listitem> |
299 | for the License.</para></listitem> | 338 | <listitem><para>Be sure the <filename>License</filename> field is correct.</para></listitem> |
300 | <listitem><para>Click <filename>Finish</filename>.</para></listitem> | 339 | <listitem><para>Click <filename>Finish</filename>.</para></listitem> |
301 | <listitem><para>Answer <filename>Yes</filename> to the open perspective prompt.</para></listitem> | 340 | <listitem><para>If the "open perspective" prompt appears, click "Yes" so that you |
302 | <listitem><para>In the Project Explorer expand your project.</para></listitem> | 341 | in the C/C++ perspective.</para></listitem> |
303 | <listitem><para>Expand <filename>src</filename>.</para></listitem> | 342 | <listitem><para>The left-hand navigation pane shows your project. |
304 | <listitem><para>Double click on your source file and the code appears | 343 | You can display your source by double clicking the project's source file. |
305 | in the window. | 344 | </para></listitem> |
306 | This is the template.</para></listitem> | ||
307 | </orderedlist> | 345 | </orderedlist> |
308 | </para> | 346 | </para> |
309 | </section> | 347 | </section> |
@@ -312,25 +350,25 @@ | |||
312 | <title>Configuring the Cross-Toolchains</title> | 350 | <title>Configuring the Cross-Toolchains</title> |
313 | 351 | ||
314 | <para> | 352 | <para> |
315 | The previous section, "<link linkend='configuring-the-cross-compiler-options'> | 353 | The previous section, "<link linkend='configuring-the-eclipse-yocto-plug-in'> |
316 | Configuring the Cross-Compiler Options</link>", set up the default project | 354 | Configuring the Eclipse Yocto Plug-in</link>", set up the default project |
317 | configurations. | 355 | configurations. |
318 | You can change these settings for a given project by following these steps: | 356 | You can change these settings for a given project by following these steps: |
319 | <orderedlist> | 357 | <orderedlist> |
320 | <listitem><para>Select <filename>Project -> Invoke Yocto Tools -> Reconfigure Yocto</filename>: | 358 | <listitem><para>Select <filename>Window -> Preferences</filename>: |
321 | This selection brings up the project's <filename>Yocto Settings</filename> Dialog. | 359 | This selection brings up the <filename>Preferences</filename> Dialog. |
322 | Settings are inherited from the default project configuration. | 360 | If the Yocto ADT Preferences are not automatically displayed, you can navigate to |
361 | that dialog by selection <filename>Yocto ADT</filename> in the left-hand | ||
362 | panel.</para> | ||
363 | <para>Yocto ADT Settings are inherited from the default project configuration. | ||
323 | The information in this dialog is identical to that chosen earlier | 364 | The information in this dialog is identical to that chosen earlier |
324 | for the <filename>Cross Compiler Option</filename> | 365 | for the Cross Compiler Options and Target Options as described in |
325 | (<filename>Stand-alone Prebuilt Toolchain</filename> or | 366 | <link linkend='configuring-the-eclipse-yocto-plug-in'> |
326 | <filename>Build System Derived Toolchain</filename>), | 367 | Configuring the Eclipse Yocto Plug-in</link> section.</para></listitem> |
327 | the <filename>Target Architecture</filename>, and the | 368 | <listitem><para>Select <filename>Project -> Reconfigure Project</filename>: |
328 | <filename>Target Options</filename>. | 369 | This selection reconfigures the project by running |
329 | The settings are inherited from the Yocto Plug-in configuration performed | 370 | <filename>autogen.sh</filename> in the workspace for your project. |
330 | after installing the plug-in.</para></listitem> | 371 | The script also runs <filename>libtoolize</filename>, <filename>aclocal</filename>, |
331 | <listitem><para><filename>Select Project -> Reconfigure Project</filename>: | ||
332 | This selection runs the <filename>autogen.sh</filename> in the workspace for your project. | ||
333 | The script runs <filename>libtoolize</filename>, <filename>aclocal</filename>, | ||
334 | <filename>autoconf</filename>, <filename>autoheader</filename>, | 372 | <filename>autoconf</filename>, <filename>autoheader</filename>, |
335 | <filename>automake --a</filename>, and | 373 | <filename>automake --a</filename>, and |
336 | <filename>./configure</filename>.</para></listitem> | 374 | <filename>./configure</filename>.</para></listitem> |
@@ -353,19 +391,12 @@ | |||
353 | <para> | 391 | <para> |
354 | To start the QEMU emulator from within Eclipse, follow these steps: | 392 | To start the QEMU emulator from within Eclipse, follow these steps: |
355 | <orderedlist> | 393 | <orderedlist> |
356 | <listitem><para>Select <filename>Run -> External Tools -> External Tools | 394 | <listitem><para>Expose the <filename>Run -> External Tools -> External Tools |
357 | Configurations...</filename>. | 395 | Configurations...</filename> menu. |
358 | This selection brings up the <filename>External Tools Configurations</filename> | 396 | Your image should appear as a selectable menu item. |
359 | Dialog.</para></listitem> | 397 | </para></listitem> |
360 | <listitem><para>Go to the left navigation area and expand <filename>Program</filename>. | 398 | <listitem><para>Select your image from the menu. |
361 | You should find the image listed. | 399 | Doing so launches a new window.</para></listitem> |
362 | For example, <filename>qemu-x86_64-poky-linux</filename>.</para></listitem> | ||
363 | <listitem><para>Click on the image. | ||
364 | This brings up a new environment in the main area of the | ||
365 | <filename>External Tools Configurations</filename> Dialog. | ||
366 | The Main tab is selected.</para></listitem> | ||
367 | <listitem><para>Click <filename>Run</filename> next. | ||
368 | This brings up a shell window.</para></listitem> | ||
369 | <listitem><para>Enter your host root password in the shell window at the prompt. | 400 | <listitem><para>Enter your host root password in the shell window at the prompt. |
370 | This sets up a <filename>Tap 0</filename> connection needed for running in user-space | 401 | This sets up a <filename>Tap 0</filename> connection needed for running in user-space |
371 | NFS mode.</para></listitem> | 402 | NFS mode.</para></listitem> |
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index 3e6b8dad17..93e013c60c 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml | |||
@@ -280,6 +280,11 @@ | |||
280 | </para></listitem> | 280 | </para></listitem> |
281 | </orderedlist> | 281 | </orderedlist> |
282 | </para> | 282 | </para> |
283 | |||
284 | <para> | ||
285 | After installing the toolchain, you must locate the target sysroot tarball and unpack it | ||
286 | into a location of your choice. | ||
287 | </para> | ||
283 | </section> | 288 | </section> |
284 | 289 | ||
285 | <section id='using-the-toolchain-from-within-the-build-tree'> | 290 | <section id='using-the-toolchain-from-within-the-build-tree'> |
@@ -321,6 +326,11 @@ | |||
321 | </para></listitem> | 326 | </para></listitem> |
322 | </orderedlist> | 327 | </orderedlist> |
323 | </para> | 328 | </para> |
329 | |||
330 | <para> | ||
331 | After installing the toolchain, you must locate the target sysroot tarball and unpack | ||
332 | it in a directory of your choice. | ||
333 | </para> | ||
324 | </section> | 334 | </section> |
325 | </section> | 335 | </section> |
326 | 336 | ||
@@ -359,8 +369,10 @@ | |||
359 | hardware or the QEMU emulator. | 369 | hardware or the QEMU emulator. |
360 | That means you either have to build them or know where to get them. | 370 | That means you either have to build them or know where to get them. |
361 | You can find lots of details on how to get or build images and kernels for your | 371 | You can find lots of details on how to get or build images and kernels for your |
362 | architecture in | 372 | architecture in the |
363 | <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-quick-start/yocto-project-qs.html'> | 373 | <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html#building-image'> |
374 | Building an Image</ulink> section of the | ||
375 | <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html'> | ||
364 | The Yocto Project Quick Start</ulink>. | 376 | The Yocto Project Quick Start</ulink>. |
365 | <note> | 377 | <note> |
366 | The Yocto Project provides basic kernels and filesystem images for several | 378 | The Yocto Project provides basic kernels and filesystem images for several |