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