diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/adt-manual/adt-command.xml | 2 | ||||
-rw-r--r-- | documentation/adt-manual/adt-intro.xml | 4 | ||||
-rw-r--r-- | documentation/adt-manual/adt-prepare.xml | 44 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 17 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 12 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 4 | ||||
-rw-r--r-- | documentation/poky-ref-manual/introduction.xml | 2 | ||||
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 31 |
8 files changed, 70 insertions, 46 deletions
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml index f5ed906962..074e51c1f1 100644 --- a/documentation/adt-manual/adt-command.xml +++ b/documentation/adt-manual/adt-command.xml | |||
@@ -32,7 +32,7 @@ | |||
32 | For an Autotools-based project, you can use the cross-toolchain by just | 32 | For an Autotools-based project, you can use the cross-toolchain by just |
33 | passing the appropriate host option to <filename>configure.sh</filename>. | 33 | passing the appropriate host option to <filename>configure.sh</filename>. |
34 | The host option you use is derived from the name of the environment setup | 34 | The host option you use is derived from the name of the environment setup |
35 | script in <filename>/opt/poky</filename> resulting from unpacking the | 35 | script in <filename>/opt/poky</filename> resulting from installation of the |
36 | cross-toolchain tarball. | 36 | cross-toolchain tarball. |
37 | For example, the host option for an ARM-based target that uses the GNU EABI | 37 | For example, the host option for an ARM-based target that uses the GNU EABI |
38 | is <filename>armv5te-poky-linux-gnueabi</filename>. | 38 | is <filename>armv5te-poky-linux-gnueabi</filename>. |
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml index 47e4c3685e..c83880b2d6 100644 --- a/documentation/adt-manual/adt-intro.xml +++ b/documentation/adt-manual/adt-intro.xml | |||
@@ -54,8 +54,8 @@ | |||
54 | <para> | 54 | <para> |
55 | The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger | 55 | The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger |
56 | that are used to develop user-space applications for targeted hardware. | 56 | that are used to develop user-space applications for targeted hardware. |
57 | This toolchain is created either by running the ADT Installer script or | 57 | This toolchain is created either by running the ADT Installer script, a toolchain installer |
58 | through a build directory that is based on your metadata | 58 | script, or through a build directory that is based on your metadata |
59 | configuration or extension for your targeted device. | 59 | configuration or extension for your targeted device. |
60 | The cross-toolchain works with a matching target sysroot. | 60 | The cross-toolchain works with a matching target sysroot. |
61 | </para> | 61 | </para> |
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index e512c89a1c..0b74505d7e 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml | |||
@@ -29,8 +29,7 @@ | |||
29 | <note> | 29 | <note> |
30 | <para>Avoid mixing installation methods when installing toolchains for different architectures. | 30 | <para>Avoid mixing installation methods when installing toolchains for different architectures. |
31 | For example, avoid using the ADT Installer to install some toolchains and then hand-installing | 31 | For example, avoid using the ADT Installer to install some toolchains and then hand-installing |
32 | cross-development toolchains from downloaded tarballs to install toolchains | 32 | cross-development toolchains by running the toolchain installer for different architectures. |
33 | for different architectures. | ||
34 | Mixing installation methods can result in situations where the ADT Installer becomes | 33 | Mixing installation methods can result in situations where the ADT Installer becomes |
35 | unreliable and might not install the toolchain.</para> | 34 | unreliable and might not install the toolchain.</para> |
36 | <para>If you must mix installation methods, you might avoid problems by deleting | 35 | <para>If you must mix installation methods, you might avoid problems by deleting |
@@ -46,9 +45,9 @@ | |||
46 | For example, you can configure the installation to install the QEMU emulator | 45 | For example, you can configure the installation to install the QEMU emulator |
47 | and the user-space NFS, specify which root filesystem profiles to download, | 46 | and the user-space NFS, specify which root filesystem profiles to download, |
48 | and define the target sysroot location.</para></listitem> | 47 | and define the target sysroot location.</para></listitem> |
49 | <listitem><para><emphasis>Use an Existing Toolchain Tarball:</emphasis> | 48 | <listitem><para><emphasis>Use an Existing Toolchain:</emphasis> |
50 | Using this method, you select and download an architecture-specific | 49 | Using this method, you select and download an architecture-specific |
51 | toolchain tarball and then hand-install the toolchain. | 50 | toolchain installer and then run the script to hand-install the toolchain. |
52 | If you use this method, you just get the cross-toolchain and QEMU - you do not | 51 | If you use this method, you just get the cross-toolchain and QEMU - you do not |
53 | get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem> | 52 | get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem> |
54 | <listitem><para><emphasis>Use the Toolchain from within the Build Directory:</emphasis> | 53 | <listitem><para><emphasis>Use the Toolchain from within the Build Directory:</emphasis> |
@@ -226,8 +225,8 @@ | |||
226 | <title>Using a Cross-Toolchain Tarball</title> | 225 | <title>Using a Cross-Toolchain Tarball</title> |
227 | 226 | ||
228 | <para> | 227 | <para> |
229 | If you want to simply install the cross-toolchain by hand, you can do so by using an existing | 228 | If you want to simply install the cross-toolchain by hand, you can do so by running the |
230 | cross-toolchain tarball. | 229 | toolchain installer. |
231 | If you use this method to install the cross-toolchain and you still need to install the target | 230 | If you use this method to install the cross-toolchain and you still need to install the target |
232 | sysroot, you will have to extract and install sysroot separately. | 231 | sysroot, you will have to extract and install sysroot separately. |
233 | For information on how to do this, see the | 232 | For information on how to do this, see the |
@@ -242,30 +241,41 @@ | |||
242 | and find the folder that matches your host development system | 241 | and find the folder that matches your host development system |
243 | (i.e. <filename>i686</filename> for 32-bit machines or | 242 | (i.e. <filename>i686</filename> for 32-bit machines or |
244 | <filename>x86-64</filename> for 64-bit machines).</para></listitem> | 243 | <filename>x86-64</filename> for 64-bit machines).</para></listitem> |
245 | <listitem><para>Go into that folder and download the toolchain tarball whose name | 244 | <listitem><para>Go into that folder and download the toolchain installer whose name |
246 | includes the appropriate target architecture. | 245 | includes the appropriate target architecture. |
247 | For example, if your host development system is an Intel-based 64-bit system and | 246 | For example, if your host development system is an Intel-based 64-bit system and |
248 | you are going to use your cross-toolchain for an Intel-based 32-bit target, go into the | 247 | you are going to use your cross-toolchain for an Intel-based 32-bit target, go into the |
249 | <filename>x86_64</filename> folder and download the following tarball: | 248 | <filename>x86_64</filename> folder and download the following installer: |
250 | <literallayout class='monospaced'> | 249 | <literallayout class='monospaced'> |
251 | poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 | 250 | poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh |
252 | </literallayout> | 251 | </literallayout> |
253 | <note><para>As an alternative to steps one and two, you can build the toolchain tarball | 252 | <note><para>As an alternative to steps one and two, you can build the toolchain installer |
254 | if you have a <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. | 253 | if you have a <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. |
255 | If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename> | 254 | If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename> |
256 | command. | 255 | command. |
257 | The resulting tarball will support such development. | 256 | The resulting installation script when run will support such development. |
258 | However, if you are not concerned with GMAE, | 257 | However, if you are not concerned with GMAE, |
259 | you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para> | 258 | you can generate the toolchain installer using |
259 | <filename>bitbake meta-toolchain</filename>.</para> | ||
260 | <para>Use the appropriate <filename>bitbake</filename> command only after you have | 260 | <para>Use the appropriate <filename>bitbake</filename> command only after you have |
261 | sourced the <filename>oe-build-init-env</filename> script located in the source | 261 | sourced the <filename>oe-build-init-env</filename> script located in the source |
262 | directory. | 262 | directory. |
263 | When the <filename>bitbake</filename> command completes, the tarball will | 263 | When the <filename>bitbake</filename> command completes, the toolchain installer will |
264 | be in <filename>tmp/deploy/sdk</filename> in the build directory. | 264 | be in <filename>tmp/deploy/sdk</filename> in the build directory. |
265 | </para></note></para></listitem> | 265 | </para></note> |
266 | <listitem><para>Make sure you are in the root directory with root privileges and then expand | 266 | </para></listitem> |
267 | the tarball. | 267 | <listitem><para>Once you have the installer, run it to install the toolchain. |
268 | The tarball expands into <filename>&YOCTO_ADTPATH_DIR;</filename>. | 268 | The following command shows how to run the installer given a toolchain tarball |
269 | for a 64-bit development host system and a 32-bit target architecture. | ||
270 | The example assumes the toolchain installer is located in <filename>~/Downloads/</filename>. | ||
271 | <literallayout class='monospaced'> | ||
272 | $ ~/Downloads/poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh | ||
273 | </literallayout> | ||
274 | <note> | ||
275 | If you do not have write permissions for the directory into which you are installing | ||
276 | the toolchain, the toolchain installer notifies you and exits. | ||
277 | Be sure you have write permissions in the directory and run the installer again. | ||
278 | </note> | ||
269 | Once the tarball is expanded, the cross-toolchain is installed. | 279 | Once the tarball is expanded, the cross-toolchain is installed. |
270 | You will notice environment setup files for the cross-toolchain in the directory. | 280 | You will notice environment setup files for the cross-toolchain in the directory. |
271 | </para></listitem> | 281 | </para></listitem> |
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 5f3b67de24..4bdb91208c 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
@@ -1066,10 +1066,17 @@ | |||
1066 | Developer's Guide for information on how to install the toolchain into the build | 1066 | Developer's Guide for information on how to install the toolchain into the build |
1067 | directory.</para></listitem> | 1067 | directory.</para></listitem> |
1068 | <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> | 1068 | <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> |
1069 | This location is where the root filesystem for the | 1069 | This location is where the root filesystem for the target hardware resides. |
1070 | target hardware is created on the development system by the ADT Installer. | 1070 | If you used the ADT Installer, then the location is |
1071 | The QEMU user-space tools, the | 1071 | <filename>/opt/poky/<release></filename>. |
1072 | NFS boot process, and the cross-toolchain all use the sysroot location. | 1072 | Additionally, when you use the ADT Installer, the same location is used for |
1073 | the QEMU user-space tools and the NFS boot process.</para> | ||
1074 | <para>If you used either of the other two methods to install the toolchain, then the | ||
1075 | location of the sysroot filesystem depends on where you separately | ||
1076 | extracted and intalled the filesystem.</para> | ||
1077 | <para>For information on how to install the toolchain and on how to extract | ||
1078 | and install the sysroot filesystem, see the | ||
1079 | "<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>" section. | ||
1073 | </para></listitem> | 1080 | </para></listitem> |
1074 | <listitem><para><emphasis>Select the Target Architecture:</emphasis> | 1081 | <listitem><para><emphasis>Select the Target Architecture:</emphasis> |
1075 | The target architecture is the type of hardware you are | 1082 | The target architecture is the type of hardware you are |
@@ -1273,7 +1280,7 @@ directory.</para></listitem> | |||
1273 | <filename>New Connections</filename> Dialog.</para></listitem> | 1280 | <filename>New Connections</filename> Dialog.</para></listitem> |
1274 | <listitem><para>Use the drop-down menu now in the <filename>Connection</filename> field and pick | 1281 | <listitem><para>Use the drop-down menu now in the <filename>Connection</filename> field and pick |
1275 | the IP Address you entered.</para></listitem> | 1282 | the IP Address you entered.</para></listitem> |
1276 | <listitem><para>Click <filename>Debug</filename> to bring up a login screen | 1283 | <listitem><para>Click <filename>Run</filename> to bring up a login screen |
1277 | and login.</para></listitem> | 1284 | and login.</para></listitem> |
1278 | <listitem><para>Accept the debug perspective.</para></listitem> | 1285 | <listitem><para>Accept the debug perspective.</para></listitem> |
1279 | </orderedlist> | 1286 | </orderedlist> |
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 9a78d40bb2..3d1983e574 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -170,7 +170,7 @@ | |||
170 | <listitem><para><anchor id='index-downloads' /><emphasis><ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink></emphasis> | 170 | <listitem><para><anchor id='index-downloads' /><emphasis><ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink></emphasis> |
171 | This area contains index releases such as | 171 | This area contains index releases such as |
172 | the <trademark class='trade'>Eclipse</trademark> | 172 | the <trademark class='trade'>Eclipse</trademark> |
173 | Yocto Plug-in, miscellaneous support, poky, pseudo, cross-development toolchains, | 173 | Yocto Plug-in, miscellaneous support, poky, pseudo, installers for cross-development toolchains, |
174 | and all released versions of Yocto Project in the form of images or tarballs. | 174 | and all released versions of Yocto Project in the form of images or tarballs. |
175 | Downloading and extracting these files does not produce a local copy of the | 175 | Downloading and extracting these files does not produce a local copy of the |
176 | Git repository but rather a snapshot of a particular release or image.</para> | 176 | Git repository but rather a snapshot of a particular release or image.</para> |
@@ -283,11 +283,11 @@ | |||
283 | tools and utilities that allow you to develop software for targeted architectures. | 283 | tools and utilities that allow you to develop software for targeted architectures. |
284 | This toolchain contains cross-compilers, linkers, and debuggers that are specific to | 284 | This toolchain contains cross-compilers, linkers, and debuggers that are specific to |
285 | an architecture. | 285 | an architecture. |
286 | You can use the OpenEmbedded build system to build cross-development toolchains in tarball | 286 | You can use the OpenEmbedded build system to build a cross-development toolchain |
287 | form that, when | 287 | installer that when run installs the toolchain that contains the development tools you |
288 | unpacked, contain the development tools you need to cross-compile and test your software. | 288 | need to cross-compile and test your software. |
289 | The Yocto Project ships with images that contain toolchains for supported architectures | 289 | The Yocto Project ships with images that contain installers for |
290 | as well. | 290 | toolchains for supported architectures as well. |
291 | Sometimes this toolchain is referred to as the meta-toolchain.</para></listitem> | 291 | Sometimes this toolchain is referred to as the meta-toolchain.</para></listitem> |
292 | <listitem><para><emphasis>Image:</emphasis> An image is the result produced when | 292 | <listitem><para><emphasis>Image:</emphasis> An image is the result produced when |
293 | BitBake processes a given collection of recipes and related metadata. | 293 | BitBake processes a given collection of recipes and related metadata. |
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 3209cb29b7..6e204d85e0 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
@@ -313,9 +313,9 @@ | |||
313 | Regardless of the type of image you are using, you need to download the pre-built kernel | 313 | Regardless of the type of image you are using, you need to download the pre-built kernel |
314 | that you will boot in the QEMU emulator and then download and extract the target root | 314 | that you will boot in the QEMU emulator and then download and extract the target root |
315 | filesystem for your target machine’s architecture. | 315 | filesystem for your target machine’s architecture. |
316 | You can get architecture-specific binaries and filesystem from | 316 | You can get architecture-specific binaries and filesystems from |
317 | <ulink url='&YOCTO_MACHINES_DL_URL;'>machines</ulink>. | 317 | <ulink url='&YOCTO_MACHINES_DL_URL;'>machines</ulink>. |
318 | You can get stand-alone toolchains from | 318 | You can get installation scripts for stand-alone toolchains from |
319 | <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'>toolchains</ulink>. | 319 | <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'>toolchains</ulink>. |
320 | Once you have all your files, you set up the environment to emulate the hardware | 320 | Once you have all your files, you set up the environment to emulate the hardware |
321 | by sourcing an environment setup script. | 321 | by sourcing an environment setup script. |
diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml index 8713239442..71717e3d77 100644 --- a/documentation/poky-ref-manual/introduction.xml +++ b/documentation/poky-ref-manual/introduction.xml | |||
@@ -103,7 +103,7 @@ | |||
103 | <ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem> | 103 | <ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem> |
104 | <listitem><para><emphasis>Nightly Builds:</emphasis> These releases are available at | 104 | <listitem><para><emphasis>Nightly Builds:</emphasis> These releases are available at |
105 | <ulink url='http://autobuilder.yoctoproject.org/nightly'/>. | 105 | <ulink url='http://autobuilder.yoctoproject.org/nightly'/>. |
106 | These builds include Yocto Project releases, meta-toolchain tarballs, and | 106 | These builds include Yocto Project releases, meta-toolchain tarball installation scripts, and |
107 | experimental builds.</para></listitem> | 107 | experimental builds.</para></listitem> |
108 | <listitem><para><emphasis>Yocto Project Website:</emphasis> You can find releases | 108 | <listitem><para><emphasis>Yocto Project Website:</emphasis> You can find releases |
109 | of the Yocto Project and supported BSPs at the | 109 | of the Yocto Project and supported BSPs at the |
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 83c204b0af..b37a45f337 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
@@ -526,9 +526,9 @@ | |||
526 | <section id='installing-the-toolchain'> | 526 | <section id='installing-the-toolchain'> |
527 | <title>Installing the Toolchain</title> | 527 | <title>Installing the Toolchain</title> |
528 | <para> | 528 | <para> |
529 | You can download a tarball with the pre-built toolchain, which includes the | 529 | You can download a tarball installer, which includes the pre-built toolchain, the |
530 | <filename>runqemu</filename> | 530 | <filename>runqemu</filename> |
531 | script and support files, from the appropriate directory under | 531 | script, and support files from the appropriate directory under |
532 | <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>. | 532 | <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>. |
533 | Toolchains are available for 32-bit and 64-bit development systems from the | 533 | Toolchains are available for 32-bit and 64-bit development systems from the |
534 | <filename>i686</filename> and <filename>x86-64</filename> directories, respectively. | 534 | <filename>i686</filename> and <filename>x86-64</filename> directories, respectively. |
@@ -539,7 +539,7 @@ | |||
539 | </para> | 539 | </para> |
540 | 540 | ||
541 | <literallayout class='monospaced'> | 541 | <literallayout class='monospaced'> |
542 | poky-eglibc-<<emphasis>host_system</emphasis>>-<<emphasis>arch</emphasis>>-toolchain-gmae-<<emphasis>release</emphasis>>.tar.bz2 | 542 | poky-eglibc-<<emphasis>host_system</emphasis>>-<<emphasis>arch</emphasis>>-toolchain-gmae-<<emphasis>release</emphasis>>.sh |
543 | 543 | ||
544 | Where: | 544 | Where: |
545 | <<emphasis>host_system</emphasis>> is a string representing your development system: | 545 | <<emphasis>host_system</emphasis>> is a string representing your development system: |
@@ -552,26 +552,33 @@ | |||
552 | </literallayout> | 552 | </literallayout> |
553 | 553 | ||
554 | <para> | 554 | <para> |
555 | For example, the following toolchain tarball is for a 64-bit development | 555 | For example, the following toolchain installer is for a 64-bit development |
556 | host system and a 32-bit target architecture: | 556 | host system and a 32-bit target architecture: |
557 | </para> | 557 | </para> |
558 | 558 | ||
559 | <literallayout class='monospaced'> | 559 | <literallayout class='monospaced'> |
560 | poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 | 560 | poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh |
561 | </literallayout> | 561 | </literallayout> |
562 | 562 | ||
563 | <para> | 563 | <para> |
564 | The toolchain tarballs are self-contained and must be installed into <filename>/opt/poky</filename>. | 564 | Toolchains are self-contained and by default are installed into <filename>/opt/poky</filename>. |
565 | The following commands show how you install the toolchain tarball given a 64-bit development | 565 | However, when you run the toolchain installer, you can choose an installation directory. |
566 | host system and a 32-bit target architecture. | 566 | </para> |
567 | The example assumes the toolchain tarball is located in <filename>~/toolchains/</filename>. | 567 | |
568 | You must have your working directory set to root before unpacking the tarball: | 568 | <para> |
569 | The following command shows how to run the installer given a toolchain tarball | ||
570 | for a 64-bit development host system and a 32-bit target architecture. | ||
571 | The example assumes the toolchain installer is located in <filename>~/Downloads/</filename>. | ||
572 | <note> | ||
573 | If you do not have write permissions for the directory into which you are installing | ||
574 | the toolchain, the toolchain installer notifies you and exits. | ||
575 | Be sure you have write permissions in the directory and run the installer again. | ||
576 | </note> | ||
569 | </para> | 577 | </para> |
570 | 578 | ||
571 | <para> | 579 | <para> |
572 | <literallayout class='monospaced'> | 580 | <literallayout class='monospaced'> |
573 | $ cd / | 581 | $ ~/Downloads/poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh |
574 | $ sudo tar -xvjf ~/toolchains/poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 | ||
575 | </literallayout> | 582 | </literallayout> |
576 | </para> | 583 | </para> |
577 | 584 | ||