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