diff options
Diffstat (limited to 'documentation/sdk-manual/sdk-using.xml')
| -rw-r--r-- | documentation/sdk-manual/sdk-using.xml | 201 |
1 files changed, 0 insertions, 201 deletions
diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml deleted file mode 100644 index 28ee50d0b7..0000000000 --- a/documentation/sdk-manual/sdk-using.xml +++ /dev/null | |||
| @@ -1,201 +0,0 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
| 4 | <!--SPDX-License-Identifier: CC-BY-2.0-UK--> | ||
| 5 | |||
| 6 | <chapter id='sdk-using-the-standard-sdk'> | ||
| 7 | <title>Using the Standard SDK</title> | ||
| 8 | |||
| 9 | <para> | ||
| 10 | This chapter describes the standard SDK and how to install it. | ||
| 11 | Information includes unique installation and setup aspects for the | ||
| 12 | standard SDK. | ||
| 13 | <note> | ||
| 14 | For a side-by-side comparison of main features supported for a | ||
| 15 | standard SDK as compared to an extensible SDK, see the | ||
| 16 | "<link linkend='sdk-manual-intro'>Introduction</link>" | ||
| 17 | section. | ||
| 18 | </note> | ||
| 19 | </para> | ||
| 20 | |||
| 21 | <para> | ||
| 22 | You can use a standard SDK to work on Makefile and Autotools-based | ||
| 23 | projects. | ||
| 24 | See the | ||
| 25 | "<link linkend='sdk-working-projects'>Using the SDK Toolchain Directly</link>" | ||
| 26 | chapter for more information. | ||
| 27 | </para> | ||
| 28 | |||
| 29 | <section id='sdk-standard-sdk-intro'> | ||
| 30 | <title>Why use the Standard SDK and What is in It?</title> | ||
| 31 | |||
| 32 | <para> | ||
| 33 | The Standard SDK provides a cross-development toolchain and | ||
| 34 | libraries tailored to the contents of a specific image. | ||
| 35 | You would use the Standard SDK if you want a more traditional | ||
| 36 | toolchain experience as compared to the extensible SDK, which | ||
| 37 | provides an internal build system and the | ||
| 38 | <filename>devtool</filename> functionality. | ||
| 39 | </para> | ||
| 40 | |||
| 41 | <para> | ||
| 42 | The installed Standard SDK consists of several files and | ||
| 43 | directories. | ||
| 44 | Basically, it contains an SDK environment setup script, some | ||
| 45 | configuration files, and host and target root filesystems to | ||
| 46 | support usage. | ||
| 47 | You can see the directory structure in the | ||
| 48 | "<link linkend='sdk-installed-standard-sdk-directory-structure'>Installed Standard SDK Directory Structure</link>" | ||
| 49 | section. | ||
| 50 | </para> | ||
| 51 | </section> | ||
| 52 | |||
| 53 | <section id='sdk-installing-the-sdk'> | ||
| 54 | <title>Installing the SDK</title> | ||
| 55 | |||
| 56 | <para> | ||
| 57 | The first thing you need to do is install the SDK on your | ||
| 58 | <ulink url='&YOCTO_DOCS_REF_URL;#hardware-build-system-term'>Build Host</ulink> | ||
| 59 | by running the <filename>*.sh</filename> installation script. | ||
| 60 | </para> | ||
| 61 | |||
| 62 | <para> | ||
| 63 | You can download a tarball installer, which includes the | ||
| 64 | pre-built toolchain, the <filename>runqemu</filename> | ||
| 65 | script, and support files from the appropriate | ||
| 66 | <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'>toolchain</ulink> | ||
| 67 | directory within the Index of Releases. | ||
| 68 | Toolchains are available for several 32-bit and 64-bit | ||
| 69 | architectures with the <filename>x86_64</filename> directories, | ||
| 70 | respectively. | ||
| 71 | The toolchains the Yocto Project provides are based off the | ||
| 72 | <filename>core-image-sato</filename> and | ||
| 73 | <filename>core-image-minimal</filename> images and contain | ||
| 74 | libraries appropriate for developing against that image. | ||
| 75 | </para> | ||
| 76 | |||
| 77 | <para> | ||
| 78 | The names of the tarball installer scripts are such that a | ||
| 79 | string representing the host system appears first in the | ||
| 80 | filename and then is immediately followed by a string | ||
| 81 | representing the target architecture. | ||
| 82 | <literallayout class='monospaced'> | ||
| 83 | poky-glibc-<replaceable>host_system</replaceable>-<replaceable>image_type</replaceable>-<replaceable>arch</replaceable>-toolchain-<replaceable>release_version</replaceable>.sh | ||
| 84 | |||
| 85 | Where: | ||
| 86 | <replaceable>host_system</replaceable> is a string representing your development system: | ||
| 87 | |||
| 88 | i686 or x86_64. | ||
| 89 | |||
| 90 | <replaceable>image_type</replaceable> is the image for which the SDK was built: | ||
| 91 | |||
| 92 | core-image-minimal or core-image-sato. | ||
| 93 | |||
| 94 | <replaceable>arch</replaceable> is a string representing the tuned target architecture: | ||
| 95 | |||
| 96 | aarch64, armv5e, core2-64, i586, mips32r2, mips64, ppc7400, or cortexa8hf-neon. | ||
| 97 | |||
| 98 | <replaceable>release_version</replaceable> is a string representing the release number of the Yocto Project: | ||
| 99 | |||
| 100 | &DISTRO;, &DISTRO;+snapshot | ||
| 101 | </literallayout> | ||
| 102 | For example, the following SDK installer is for a 64-bit | ||
| 103 | development host system and a i586-tuned target architecture | ||
| 104 | based off the SDK for <filename>core-image-sato</filename> and | ||
| 105 | using the current &DISTRO; snapshot: | ||
| 106 | <literallayout class='monospaced'> | ||
| 107 | poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh | ||
| 108 | </literallayout> | ||
| 109 | <note> | ||
| 110 | As an alternative to downloading an SDK, you can build the | ||
| 111 | SDK installer. | ||
| 112 | For information on building the installer, see the | ||
| 113 | "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>" | ||
| 114 | section. | ||
| 115 | </note> | ||
| 116 | </para> | ||
| 117 | |||
| 118 | <para> | ||
| 119 | The SDK and toolchains are self-contained and by default are | ||
| 120 | installed into the <filename>poky_sdk</filename> folder in your | ||
| 121 | home directory. | ||
| 122 | You can choose to install the extensible SDK in any location when | ||
| 123 | you run the installer. | ||
| 124 | However, because files need to be written under that directory | ||
| 125 | during the normal course of operation, the location you choose | ||
| 126 | for installation must be writable for whichever | ||
| 127 | users need to use the SDK. | ||
| 128 | </para> | ||
| 129 | |||
| 130 | <para> | ||
| 131 | The following command shows how to run the installer given a | ||
| 132 | toolchain tarball for a 64-bit x86 development host system and | ||
| 133 | a 64-bit x86 target architecture. | ||
| 134 | The example assumes the SDK installer is located in | ||
| 135 | <filename>~/Downloads/</filename> and has execution rights. | ||
| 136 | <note> | ||
| 137 | If you do not have write permissions for the directory | ||
| 138 | into which you are installing the SDK, the installer | ||
| 139 | notifies you and exits. | ||
| 140 | For that case, set up the proper permissions in the directory | ||
| 141 | and run the installer again. | ||
| 142 | </note> | ||
| 143 | <literallayout class='monospaced'> | ||
| 144 | $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh | ||
| 145 | Poky (Yocto Project Reference Distro) SDK installer version &DISTRO; | ||
| 146 | =============================================================== | ||
| 147 | Enter target directory for SDK (default: /opt/poky/&DISTRO;): | ||
| 148 | You are about to install the SDK to "/opt/poky/&DISTRO;". Proceed [Y/n]? Y | ||
| 149 | Extracting SDK........................................ ..............................done | ||
| 150 | Setting it up...done | ||
| 151 | SDK has been successfully set up and is ready to be used. | ||
| 152 | Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. | ||
| 153 | $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux | ||
| 154 | </literallayout> | ||
| 155 | </para> | ||
| 156 | |||
| 157 | <para> | ||
| 158 | Again, reference the | ||
| 159 | "<link linkend='sdk-installed-standard-sdk-directory-structure'>Installed Standard SDK Directory Structure</link>" | ||
| 160 | section for more details on the resulting directory structure of | ||
| 161 | the installed SDK. | ||
| 162 | </para> | ||
| 163 | </section> | ||
| 164 | |||
| 165 | <section id='sdk-running-the-sdk-environment-setup-script'> | ||
| 166 | <title>Running the SDK Environment Setup Script</title> | ||
| 167 | |||
| 168 | <para> | ||
| 169 | Once you have the SDK installed, you must run the SDK environment | ||
| 170 | setup script before you can actually use the SDK. | ||
| 171 | This setup script resides in the directory you chose when you | ||
| 172 | installed the SDK, which is either the default | ||
| 173 | <filename>/opt/poky/&DISTRO;</filename> directory or the directory | ||
| 174 | you chose during installation. | ||
| 175 | </para> | ||
| 176 | |||
| 177 | <para> | ||
| 178 | Before running the script, be sure it is the one that matches the | ||
| 179 | architecture for which you are developing. | ||
| 180 | Environment setup scripts begin with the string | ||
| 181 | "<filename>environment-setup</filename>" and include as part of | ||
| 182 | their name the tuned target architecture. | ||
| 183 | As an example, the following commands set the working directory | ||
| 184 | to where the SDK was installed and then source the environment | ||
| 185 | setup script. | ||
| 186 | In this example, the setup script is for an IA-based | ||
| 187 | target machine using i586 tuning: | ||
| 188 | <literallayout class='monospaced'> | ||
| 189 | $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux | ||
| 190 | </literallayout> | ||
| 191 | When you run the setup script, the same environment variables are | ||
| 192 | defined as are when you run the setup script for an extensible SDK. | ||
| 193 | See the | ||
| 194 | "<link linkend='sdk-running-the-extensible-sdk-environment-setup-script'>Running the Extensible SDK Environment Setup Script</link>" | ||
| 195 | section for more information. | ||
| 196 | </para> | ||
| 197 | </section> | ||
| 198 | </chapter> | ||
| 199 | <!-- | ||
| 200 | vim: expandtab tw=80 ts=4 | ||
| 201 | --> | ||
