summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual/sdk-using.rst
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-14 13:34:34 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:35 +0100
commitde89b5a0b6ecb9a5b6a3e5a862cf4cee32dc8a94 (patch)
tree9851be19b42edfb032ff83308d77bd863b11159d /documentation/sdk-manual/sdk-using.rst
parent688e49bb5e6e61b5c0dbbe6b2c3bdf1c5a4bef8d (diff)
downloadpoky-de89b5a0b6ecb9a5b6a3e5a862cf4cee32dc8a94.tar.gz
sphinx: sdk-manual: Various URL, code block and other fixes to imported data
(From yocto-docs rev: 12f5e9cb36409b813ffef9242ce9a042f08acf69) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual/sdk-using.rst')
-rw-r--r--documentation/sdk-manual/sdk-using.rst73
1 files changed, 47 insertions, 26 deletions
diff --git a/documentation/sdk-manual/sdk-using.rst b/documentation/sdk-manual/sdk-using.rst
index b240f9174a..cd57f07eeb 100644
--- a/documentation/sdk-manual/sdk-using.rst
+++ b/documentation/sdk-manual/sdk-using.rst
@@ -42,13 +42,12 @@ Structure <#sdk-installed-standard-sdk-directory-structure>`__" section.
42Installing the SDK 42Installing the SDK
43================== 43==================
44 44
45The first thing you need to do is install the SDK on your `Build 45The first thing you need to do is install the SDK on your :term:`Build
46Host <&YOCTO_DOCS_REF_URL;#hardware-build-system-term>`__ by running the 46Host` by running the ``*.sh`` installation script.
47``*.sh`` installation script.
48 47
49You can download a tarball installer, which includes the pre-built 48You can download a tarball installer, which includes the pre-built
50toolchain, the ``runqemu`` script, and support files from the 49toolchain, the ``runqemu`` script, and support files from the
51appropriate `toolchain <&YOCTO_TOOLCHAIN_DL_URL;>`__ directory within 50appropriate :yocto_dl:`toolchain <releases/yocto/yocto-3.1.2/toolchain/>` directory within
52the Index of Releases. Toolchains are available for several 32-bit and 51the Index of Releases. Toolchains are available for several 32-bit and
5364-bit architectures with the ``x86_64`` directories, respectively. The 5264-bit architectures with the ``x86_64`` directories, respectively. The
54toolchains the Yocto Project provides are based off the 53toolchains the Yocto Project provides are based off the
@@ -58,17 +57,33 @@ libraries appropriate for developing against that image.
58The names of the tarball installer scripts are such that a string 57The names of the tarball installer scripts are such that a string
59representing the host system appears first in the filename and then is 58representing the host system appears first in the filename and then is
60immediately followed by a string representing the target architecture. 59immediately followed by a string representing the target architecture.
61poky-glibc-host_system-image_type-arch-toolchain-release_version.sh 60::
62Where: host_system is a string representing your development system: 61
63i686 or x86_64. image_type is the image for which the SDK was built: 62 poky-glibc-host_system-image_type-arch-toolchain-release_version.sh
64core-image-minimal or core-image-sato. arch is a string representing the 63
65tuned target architecture: aarch64, armv5e, core2-64, i586, mips32r2, 64 Where:
66mips64, ppc7400, or cortexa8hf-neon. release_version is a string 65 host_system is a string representing your development system:
67representing the release number of the Yocto Project: DISTRO, 66
68DISTRO+snapshot For example, the following SDK installer is for a 64-bit 67 i686 or x86_64.
68
69 image_type is the image for which the SDK was built:
70
71 core-image-minimal or core-image-sato.
72
73 arch is a string representing the tuned target architecture:
74
75 aarch64, armv5e, core2-64, i586, mips32r2, mips64, ppc7400, or cortexa8hf-neon.
76
77 release_version is a string representing the release number of the Yocto Project:
78
79 3.1.2, 3.1.2+snapshot
80
81For example, the following SDK installer is for a 64-bit
69development host system and a i586-tuned target architecture based off 82development host system and a i586-tuned target architecture based off
70the SDK for ``core-image-sato`` and using the current DISTRO snapshot: 83the SDK for ``core-image-sato`` and using the current DISTRO snapshot:
71poky-glibc-x86_64-core-image-sato-i586-toolchain-DISTRO.sh 84::
85
86 poky-glibc-x86_64-core-image-sato-i586-toolchain-DISTRO.sh
72 87
73.. note:: 88.. note::
74 89
@@ -96,16 +111,18 @@ architecture. The example assumes the SDK installer is located in
96 that case, set up the proper permissions in the directory and run the 111 that case, set up the proper permissions in the directory and run the
97 installer again. 112 installer again.
98 113
99$ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-DISTRO.sh 114::
100Poky (Yocto Project Reference Distro) SDK installer version DISTRO 115
101=============================================================== Enter 116 $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-3.1.2.sh
102target directory for SDK (default: /opt/poky/DISTRO): You are about to 117 Poky (Yocto Project Reference Distro) SDK installer version 3.1.2
103install the SDK to "/opt/poky/DISTRO". Proceed [Y/n]? Y Extracting 118 ===============================================================
104SDK........................................ 119 Enter target directory for SDK (default: /opt/poky/3.1.2):
105..............................done Setting it up...done SDK has been 120 You are about to install the SDK to "/opt/poky/3.1.2". Proceed [Y/n]? Y
106successfully set up and is ready to be used. Each time you wish to use 121 Extracting SDK........................................ ..............................done
107the SDK in a new shell session, you need to source the environment setup 122 Setting it up...done
108script e.g. $ . /opt/poky/DISTRO/environment-setup-i586-poky-linux 123 SDK has been successfully set up and is ready to be used.
124 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
125 $ . /opt/poky/3.1.2/environment-setup-i586-poky-linux
109 126
110Again, reference the "`Installed Standard SDK Directory 127Again, reference the "`Installed Standard SDK Directory
111Structure <#sdk-installed-standard-sdk-directory-structure>`__" section 128Structure <#sdk-installed-standard-sdk-directory-structure>`__" section
@@ -120,7 +137,7 @@ Running the SDK Environment Setup Script
120Once you have the SDK installed, you must run the SDK environment setup 137Once you have the SDK installed, you must run the SDK environment setup
121script before you can actually use the SDK. This setup script resides in 138script before you can actually use the SDK. This setup script resides in
122the directory you chose when you installed the SDK, which is either the 139the directory you chose when you installed the SDK, which is either the
123default ``/opt/poky/DISTRO`` directory or the directory you chose during 140default ``/opt/poky/3.1.2`` directory or the directory you chose during
124installation. 141installation.
125 142
126Before running the script, be sure it is the one that matches the 143Before running the script, be sure it is the one that matches the
@@ -129,8 +146,12 @@ begin with the string "``environment-setup``" and include as part of
129their name the tuned target architecture. As an example, the following 146their name the tuned target architecture. As an example, the following
130commands set the working directory to where the SDK was installed and 147commands set the working directory to where the SDK was installed and
131then source the environment setup script. In this example, the setup 148then source the environment setup script. In this example, the setup
132script is for an IA-based target machine using i586 tuning: $ source 149script is for an IA-based target machine using i586 tuning:
133/opt/poky/DISTRO/environment-setup-i586-poky-linux When you run the 150::
151
152 $ source /opt/poky/3.1.2/environment-setup-i586-poky-linux
153
154When you run the
134setup script, the same environment variables are defined as are when you 155setup script, the same environment variables are defined as are when you
135run the setup script for an extensible SDK. See the "`Running the 156run the setup script for an extensible SDK. See the "`Running the
136Extensible SDK Environment Setup 157Extensible SDK Environment Setup