summaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-08-09 07:40:32 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-08-13 12:18:55 (GMT)
commit6f77a176f74a8ef205814193c7b466286ef80f87 (patch)
tree128cd7c5bcaa05515b441bcacbc340096ffb9709 /documentation/adt-manual
parent089fcba0c5f41a5081be6cd2674ffd03f382159f (diff)
downloadpoky-6f77a176f74a8ef205814193c7b466286ef80f87.tar.gz
adt-manual: Organized building a toolchain installer into a section.
An improvement to expose the method by which the user gets a toolchain installer. I placed this information in a section of its own rather than having it buried in a note. (From yocto-docs rev: a1c2bb48f47cee9ee8c5c079afbcf77a793ca791) 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-prepare.xml163
1 files changed, 94 insertions, 69 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index a2a439d..343b741 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -231,7 +231,7 @@
231 <para> 231 <para>
232 If you want to simply install the cross-toolchain by hand, you can 232 If you want to simply install the cross-toolchain by hand, you can
233 do so by running the toolchain installer. 233 do so by running the toolchain installer.
234 If you use this method to install the cross-toolchain and you 234 If you use this method to install the cross-toolchain, you
235 might still need to install the target sysroot by installing and 235 might still need to install the target sysroot by installing and
236 extracting it separately. 236 extracting it separately.
237 For information on how to install the sysroot, see the 237 For information on how to install the sysroot, see the
@@ -241,82 +241,56 @@
241 <para> 241 <para>
242 Follow these steps: 242 Follow these steps:
243 <orderedlist> 243 <orderedlist>
244 <listitem><para>Go to 244 <listitem><para>Get the toolchain installer using one of the
245 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink> 245 following methods:
246 and find the folder that matches your host development system 246 <itemizedlist>
247 (i.e. <filename>i686</filename> for 32-bit machines or 247 <listitem><para>Go to
248 <filename>x86-64</filename> for 64-bit machines).</para></listitem> 248 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>
249 <listitem><para>Go into that folder and download the toolchain installer whose name 249 and find the folder that matches your host
250 includes the appropriate target architecture. 250 development system (i.e. <filename>i686</filename>
251 For example, if your host development system is an Intel-based 64-bit system and 251 for 32-bit machines or <filename>x86-64</filename>
252 you are going to use your cross-toolchain for an Intel-based 32-bit target, go into the 252 for 64-bit machines).</para>
253 <filename>x86_64</filename> folder and download the following installer: 253 <para>Go into that folder and download the toolchain
254 <literallayout class='monospaced'> 254 installer whose name includes the appropriate target
255 architecture.
256 For example, if your host development system is an
257 Intel-based 64-bit system and you are going to use
258 your cross-toolchain for an Intel-based 32-bit
259 target, go into the <filename>x86_64</filename>
260 folder and download the following installer:
261 <literallayout class='monospaced'>
255 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh 262 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh
256 </literallayout> 263 </literallayout></para></listitem>
257 <note><para>As an alternative to steps one and two, you can 264 <listitem><para>Build your own toolchain installer.
258 build the toolchain installer if you have a 265 For cases where you cannot use an installer
259 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 266 from the download area, you can build your as
260 If you need GMAE, you should use the 267 described in the
261 <filename>bitbake meta-toolchain-gmae</filename> 268 "<link linkend='optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</link>"
262 command. 269 section.</para></listitem>
263 Running the resulting installation script will support 270 </itemizedlist></para></listitem>
264 such development. 271 <listitem><para>Once you have the installer, run it to install
265 If you are not concerned with GMAE, you can generate 272 the toolchain.
266 the toolchain installer using
267 <filename>bitbake meta-toolchain</filename>.
268 Either of these methods requires you to still
269 install the target sysroot by installing and
270 extracting it separately.
271 For information on how to install the sysroot, see the
272 "<link linkend='extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" section.
273 </para>
274 <para>A final method of building the toolchain installer
275 exists that has significant advantages over the previous
276 two methods.
277 This method results in a toolchain installer that
278 contains the sysroot that matches your target root
279 filesystem.
280 To build this installer, use the
281 <filename>bitbake image -c populate_sdk</filename>
282 command.</para>
283 <para>Remember, before using any
284 <filename>bitbake</filename> command, you must source
285 the <filename>&OE_INIT_PATH;</filename> script
286 located in the Source Directory and you must make sure
287 your <filename>conf/local.conf</filename> variables are
288 correct.
289 In particular, you need to be sure the
290 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
291 variable matches the architecture for which you are
292 building and that the
293 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>
294 variable is correctly set if you are building
295 a toolchain designed to run on an architecture that
296 differs from your current development host machine
297 (i.e. the build machine).</para>
298 <para>When the BitBake command
299 completes, the toolchain installer will be in
300 <filename>tmp/deploy/sdk</filename> in the Build
301 Directory.</para>
302 </note></para></listitem>
303 <listitem><para>Once you have the installer, run it to install the toolchain.
304 You must change the permissions on the toolchain installer 273 You must change the permissions on the toolchain installer
305 script so that it is executable.</para> 274 script so that it is executable.</para>
306 <para>The following command shows how to run the installer given a toolchain tarball 275 <para>The following command shows how to run the installer
307 for a 64-bit development host system and a 32-bit target architecture. 276 given a toolchain tarball for a 64-bit development host
308 The example assumes the toolchain installer is located in <filename>~/Downloads/</filename>. 277 system and a 32-bit target architecture.
278 The example assumes the toolchain installer is located
279 in <filename>~/Downloads/</filename>.
309 <literallayout class='monospaced'> 280 <literallayout class='monospaced'>
310 $ ~/Downloads/poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh 281 $ ~/Downloads/poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh
311 </literallayout> 282 </literallayout>
312 <note> 283 <note>
313 If you do not have write permissions for the directory into which you are installing 284 If you do not have write permissions for the directory
314 the toolchain, the toolchain installer notifies you and exits. 285 into which you are installing the toolchain, the
315 Be sure you have write permissions in the directory and run the installer again. 286 toolchain installer notifies you and exits.
287 Be sure you have write permissions in the directory and
288 run the installer again.
316 </note> 289 </note>
317 Once the tarball is expanded, the cross-toolchain is installed. 290 Once the tarball is expanded, the cross-toolchain is
318 You will notice environment setup files for the cross-toolchain in the directory. 291 installed.
319 </para></listitem> 292 You will notice environment setup files for the
293 cross-toolchain in the directory.</para></listitem>
320 </orderedlist> 294 </orderedlist>
321 </para> 295 </para>
322 </section> 296 </section>
@@ -539,6 +513,57 @@
539 </section> 513 </section>
540</section> 514</section>
541 515
516<section id='optionally-building-a-toolchain-installer'>
517 <title>Optionally Building a Toolchain Installer</title>
518
519 <para>
520 As an alternative to locating and downloading a toolchain installer,
521 you can build the toolchain installer if you have a
522 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
523 </para>
524
525 <para>
526 If you need GMAE, you should use the
527 <filename>bitbake meta-toolchain-gmae</filename> command.
528 Running the resulting installation script will support such development.
529 If you are not concerned with GMAE, you can build the toolchain
530 installer using <filename>bitbake meta-toolchain</filename>.
531 Either of these methods requires you to still install the target
532 sysroot by installing and extracting it separately.
533 For information on how to install the sysroot, see the
534 "<link linkend='extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" section.
535 </para>
536
537 <para>
538 A final method of building the toolchain installer exists that has
539 significant advantages over the previous two methods.
540 This method results in a toolchain installer that contains the sysroot
541 that matches your target root filesystem.
542 To build this installer, use the
543 <filename>bitbake image -c populate_sdk</filename> command.
544 </para>
545
546 <para>
547 Remember, before using any <filename>bitbake</filename> command, you
548 must source the <filename>&OE_INIT_PATH;</filename> script located in
549 the Source Directory and you must make sure your
550 <filename>conf/local.conf</filename> variables are correct.
551 In particular, you need to be sure the
552 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
553 variable matches the architecture for which you are building and that
554 the
555 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>
556 variable is correctly set if you are building a toolchain designed to
557 run on an architecture that differs from your current development host
558 machine (i.e. the build machine).
559 </para>
560
561 <para>
562 When the BitBake command completes, the toolchain installer will be in
563 <filename>tmp/deploy/sdk</filename> in the Build Directory.
564 </para>
565</section>
566
542</chapter> 567</chapter>
543<!-- 568<!--
544vim: expandtab tw=80 ts=4 569vim: expandtab tw=80 ts=4