summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-09-15 12:12:06 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-09-25 17:59:58 +0100
commit468f2ff3cbf9b72187d52fe954c2e4b9478a2abd (patch)
treee14305d69664a613a3378adb06cd5ec0c04c8ab2 /documentation
parent9960c920836e2ff0d8238b7abd0ba638a963529e (diff)
downloadpoky-468f2ff3cbf9b72187d52fe954c2e4b9478a2abd.tar.gz
documentation/adt-manual/adt-prepare.xml: applied Jessica Zhang revisions
These changes reflect corrections resulting from Jessica Zhang's review of the sections. (From yocto-docs rev: c3fed39bc3909c38424e7e72c40471dcb0053c8d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/adt-manual/adt-prepare.xml73
1 files changed, 38 insertions, 35 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index 3eacf859dd..094ae01cb6 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -34,8 +34,8 @@
34 If you use this method, you just get the cross-toolchain and QEMU - you do not 34 If you use this method, you just get the cross-toolchain and QEMU - you do not
35 get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem> 35 get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem>
36 <listitem><para><emphasis>Use the Toolchain from within a Yocto Project Build Tree:</emphasis> 36 <listitem><para><emphasis>Use the Toolchain from within a Yocto Project Build Tree:</emphasis>
37 If you already have a Yocto Project build tree, you can install the cross-toolchain 37 If you already have a Yocto Project build tree, you can build the cross-toolchain
38 using that tree. 38 within tree.
39 However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you 39 However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you
40 do not get any of the other benefits without taking separate steps.</para></listitem> 40 do not get any of the other benefits without taking separate steps.</para></listitem>
41 </itemizedlist> 41 </itemizedlist>
@@ -62,7 +62,8 @@
62 62
63 <para> 63 <para>
64 If you use BitBake to generate the ADT Installer tarball, you must 64 If you use BitBake to generate the ADT Installer tarball, you must
65 <filename>source</filename> the Yocto Project environment setup script located 65 <filename>source</filename> the Yocto Project environment setup script
66 (<filename>oe-init-build-env</filename>) located
66 in the Yocto Project file structure before running the <filename>bitbake</filename> 67 in the Yocto Project file structure before running the <filename>bitbake</filename>
67 command that creates the tarball. 68 command that creates the tarball.
68 </para> 69 </para>
@@ -209,30 +210,30 @@
209 <listitem><para>Go into that folder and download the toolchain tarball whose name 210 <listitem><para>Go into that folder and download the toolchain tarball whose name
210 includes the appropriate target architecture. 211 includes the appropriate target architecture.
211 For example, if your host development system is an Intel-based 64-bit system and 212 For example, if your host development system is an Intel-based 64-bit system and
212 you are going to use your cross-toolchain for an ARM-based target, go into the 213 you are going to use your cross-toolchain for an Intel-based 32-bit target, go into the
213 <filename>x86_64</filename> folder and download the following tarball: 214 <filename>x86_64</filename> folder and download the following tarball:
214 <literallayout class='monospaced'> 215 <literallayout class='monospaced'>
215 yocto-eglibc-x86_64-i586-toolchain-gmae-1.1.tar.bz2 216 yocto-eglibc-x86_64-i586-toolchain-gmae-1.1.tar.bz2
216 </literallayout> 217 </literallayout>
217 The cross-toolchain tarballs provided by the Yocto Project support development 218 The cross-toolchain tarballs provided by the Yocto Project support development
218 of GNOME platorms on mobile devices (GMAE). 219 of GNOME platforms on mobile devices (GMAE).
219 <note><para>As an alternative to steps one and two, you can build the toolchain tarball 220 <note><para>As an alternative to steps one and two, you can build the toolchain tarball
220 if you have a Yocto Project build tree. 221 if you have a Yocto Project build tree.
221 If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename> 222 If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename>
222 command. 223 command.
223 The resulting tarball will support such development. 224 The resulting tarball will support such development.
224 However, if you not concerned with GMAE, 225 However, if you are not concerned with GMAE,
225 you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para> 226 you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para>
226 <para>Use the appropriate <filename>bitbake</filename> command only after you have 227 <para>Use the appropriate <filename>bitbake</filename> command only after you have
227 sourced the <filename>oe-build-init script</filename> located in the Yocto 228 sourced the <filename>oe-build-init-env</filename> script located in the Yocto
228 Project files. 229 Project files.
229 When the <filename>bitbake</filename> command completes, the toolchain tarball will 230 When the <filename>bitbake</filename> command completes, the tarball will
230 be in <filename>tmp/deploy/sdk</filename> in the Yocto Project build tree. 231 be in <filename>tmp/deploy/sdk</filename> in the Yocto Project build tree.
231 </para></note></para></listitem> 232 </para></note></para></listitem>
232 <listitem><para>Make sure you are in the root directory with root privileges and then expand 233 <listitem><para>Make sure you are in the root directory with root privileges and then expand
233 the tarball. 234 the tarball.
234 The tarball expands into <filename>/opt/poky/$SDKVERSION</filename>. 235 The tarball expands into <filename>/opt/poky/$SDKVERSION</filename>.
235 Once the tarball in unpacked, the cross-toolchain is installed. 236 Once the tarball is expanded, the cross-toolchain is installed.
236 You will notice environment setup files for the cross-toolchain in the directory. 237 You will notice environment setup files for the cross-toolchain in the directory.
237 </para></listitem> 238 </para></listitem>
238 </orderedlist> 239 </orderedlist>
@@ -243,21 +244,19 @@
243 <title>Using BitBake and the Yocto Project Build Tree</title> 244 <title>Using BitBake and the Yocto Project Build Tree</title>
244 245
245 <para> 246 <para>
246 A final way of installing just the cross-toolchain is to use BitBake within an existing 247 A final way of installing just the cross-toolchain is to use BitBake to build the
247 Yocto Project build tree. 248 toolchain within an existing Yocto Project build tree.
248 This method installs the toolchain into the Yocto Project build tree, not the 249 This method does not install the toolchain into the <filename>/opt</filename> directory.
249 <filename>/opt</filename> directory.
250 As with the previous method, if you need to install the target sysroot, you must 250 As with the previous method, if you need to install the target sysroot, you must
251 do this separately. 251 do this separately.
252 </para> 252 </para>
253 253
254 <para> 254 <para>
255 Follow these steps to install the toolchain into the build tree: 255 Follow these steps to build and install the toolchain into the build tree:
256 <orderedlist> 256 <orderedlist>
257 <listitem><para>Source the environment setup script located in the Yocto Project 257 <listitem><para>Source the environment setup script
258 files. 258 <filename>oe-init-build-env</filename> located in the Yocto Project
259 The script has the string <filename>init-build-env</filename> 259 files.</para></listitem>
260 as part of the name.</para></listitem>
261 <listitem><para>At this point, you should be sure that the 260 <listitem><para>At this point, you should be sure that the
262 <filename>MACHINE</filename> variable 261 <filename>MACHINE</filename> variable
263 in the <filename>local.conf</filename> file found in the Yocto Project 262 in the <filename>local.conf</filename> file found in the Yocto Project
@@ -272,12 +271,12 @@
272 command.</note></para></listitem> 271 command.</note></para></listitem>
273 <listitem><para>Run <filename>bitbake meta-ide-support</filename> to complete the 272 <listitem><para>Run <filename>bitbake meta-ide-support</filename> to complete the
274 cross-toolchain installation. 273 cross-toolchain installation.
275 <note>If you change your working directory after you 274 <note>If change out of your working directory after you
276 <filename>source</filename> the environment setup script and before you run 275 <filename>source</filename> the environment setup script and before you run
277 the BitBake command, the command will not work. 276 the BitBake command, the command might not work.
278 Be sure to run the <filename>bitbake</filename> command immediately 277 Be sure to run the <filename>bitbake</filename> command immediately
279 after checking or editing the <filename>local.conf</filename> but without 278 after checking or editing the <filename>local.conf</filename> but without
280 changing your working directory.</note> 279 changing out of your working directory.</note>
281 Once BitBake finishes, the cross-toolchain is installed within the Yocto Project 280 Once BitBake finishes, the cross-toolchain is installed within the Yocto Project
282 build tree. 281 build tree.
283 You will notice environment setup files for the cross-toolchain in the 282 You will notice environment setup files for the cross-toolchain in the
@@ -289,12 +288,12 @@
289 </section> 288 </section>
290</section> 289</section>
291 290
292<section id='setting-up-the-environment'> 291<section id='setting-up-the-cross-development-environment'>
293 <title>Setting Up the Environment</title> 292 <title>Setting Up the Cross-Development Environment</title>
294 293
295 <para> 294 <para>
296 Before you can use the cross-toolchain, you need to set up the toolchain environment by 295 Before you can develop using the cross-toolchain, you need to set up the
297 sourcing the environment setup script. 296 cross-development environment by sourcing the environment setup script.
298 If you used the ADT Installer or used an existing ADT tarball to install the ADT, 297 If you used the ADT Installer or used an existing ADT tarball to install the ADT,
299 then you can find this script in the <filename>/opt/poky/$SDKVERSION</filename> 298 then you can find this script in the <filename>/opt/poky/$SDKVERSION</filename>
300 directory. 299 directory.
@@ -323,14 +322,13 @@
323 hardware or the QEMU emulator. 322 hardware or the QEMU emulator.
324 Furthermore, if you plan on booting your image using NFS or you want to use the root filesystem 323 Furthermore, if you plan on booting your image using NFS or you want to use the root filesystem
325 as the target sysroot, you need to extract the root filesystem. 324 as the target sysroot, you need to extract the root filesystem.
326 This section describes how to get set up with the kernel and filesystem images.
327 </para> 325 </para>
328 326
329 <section id='getting-the-images'> 327 <section id='getting-the-images'>
330 <title>Getting the Images</title> 328 <title>Getting the Images</title>
331 329
332 <para> 330 <para>
333 To get the kernel and filesystem images you either have to build them or download 331 To get the kernel and filesystem images, you either have to build them or download
334 pre-built versions. 332 pre-built versions.
335 You can find examples for both these situations in the 333 You can find examples for both these situations in the
336 "<ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html#test-run'>A 334 "<ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html#test-run'>A
@@ -346,7 +344,9 @@
346 area - <ulink url='http://autobuilder.yoctoproject.org/downloads/yocto-1.1/machines/'></ulink> 344 area - <ulink url='http://autobuilder.yoctoproject.org/downloads/yocto-1.1/machines/'></ulink>
347 and are ideal for experimentation within Yocto Project.</para> 345 and are ideal for experimentation within Yocto Project.</para>
348 <para>If you plan on remotely deploying and debugging your application from within the 346 <para>If you plan on remotely deploying and debugging your application from within the
349 Eclipse IDE, you must have an image that supports Sato. 347 Eclipse IDE, you must have an image that contains the Yocto Target Communication
348 Framework (TCF) agent (<filename>tcf-agent</filename>), which is the
349 <filename>core-image-sato-sdk</filename> image.
350 For information on the image types you can build using the Yocto Project, see 350 For information on the image types you can build using the Yocto Project, see
351 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#ref-images'> 351 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#ref-images'>
352 Reference: Images</ulink> in 352 Reference: Images</ulink> in
@@ -360,23 +360,26 @@
360 <title>Extracting the Root Filesystem</title> 360 <title>Extracting the Root Filesystem</title>
361 361
362 <para> 362 <para>
363 You must extract the root filesystem if you want to boot the image using NFS or you 363 You must extract the root filesystem if you want to boot the image using NFS
364 want to use the root filesystem as the target sysroot. 364 or you want to use the root filesystem as the target sysroot.
365 For example, the Eclipse IDE environment with the Eclipse Yocto Plug-in installed allows you 365 For example, the Eclipse IDE environment with the Eclipse Yocto Plug-in installed allows you
366 to boot under NFS. 366 to use QEMU to boot under NFS.
367 Another example is if you want to test your image against actual hardware with the 367 Another example is if you want to develop your target application using the
368 root filesystem as the target sysroot. 368 root filesystem as the target sysroot.
369 </para> 369 </para>
370 370
371 <para> 371 <para>
372 To extract the root filesystem you use the <filename>runqemu-extract-sdk</filename> command on the 372 To extract the root filesystem, first <filename>source</filename>
373 the cross-development environment setup script and then
374 use the <filename>runqemu-extract-sdk</filename> command on the
373 filesystem image. 375 filesystem image.
374 For example, the following command extracts the root filesystem from a previously built 376 For example, the following commands set up the environment and then extract
375 filesystem image tarball named 377 the root filesystem from a previously built filesystem image tarball named
376 <filename>core-image-sato-sdk-qemux86-2011091411831.rootfs.tar.bz2</filename>. 378 <filename>core-image-sato-sdk-qemux86-2011091411831.rootfs.tar.bz2</filename>.
377 The example extracts the root filesystem into the <filename>$HOME/qemux86-sato</filename> 379 The example extracts the root filesystem into the <filename>$HOME/qemux86-sato</filename>
378 directory: 380 directory:
379 <literallayout class='monospaced'> 381 <literallayout class='monospaced'>
382 $ source $HOME/poky/build/tmp/environment-setup-i586-poky-linux
380 $ runqemu-extract-sdk \ 383 $ runqemu-extract-sdk \
381 tmp/deploy/images/core-image-sato-sdk-qemux86-2011091411831.rootfs.tar.bz2 \ 384 tmp/deploy/images/core-image-sato-sdk-qemux86-2011091411831.rootfs.tar.bz2 \
382 $HOME/qemux86-sato 385 $HOME/qemux86-sato