summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual/sdk-extensible.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-05-18 11:16:24 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-05-24 17:16:36 +0100
commit63a151b8749cddc76f5a056abb93516fff16022e (patch)
treed148fb7e9abf9edc2cdbddb8185c3b40f6ab76b7 /documentation/sdk-manual/sdk-extensible.xml
parentfc99fc952e63e7a90545004c7e09de175a57f051 (diff)
downloadpoky-63a151b8749cddc76f5a056abb93516fff16022e.tar.gz
sdk-manual: Updated the "Installing the Extensible SDK" section.
The text had not been updated to include the many architectures now supported in the Index of Releases toolchain directories. I added the list of architectures. Renamed the section to a more appropriate section heading. Verified the example and put in the latest output. (From yocto-docs rev: a567f5101d230ef1fa4428e9c6905e9e23bd5855) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual/sdk-extensible.xml')
-rw-r--r--documentation/sdk-manual/sdk-extensible.xml63
1 files changed, 36 insertions, 27 deletions
diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index 3a99b3791b..0389cb4448 100644
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -54,29 +54,29 @@
54 </para> 54 </para>
55 </section> 55 </section>
56 56
57 <section id='sdk-setting-up-to-use-the-extensible-sdk'> 57 <section id='sdk-installing-the-extensible-sdk'>
58 <title>Setting Up to Use the Extensible SDK</title> 58 <title>Installing the Extensible SDK</title>
59 59
60 <para> 60 <para>
61 The first thing you need to do is install the SDK on your host 61 The first thing you need to do is install the SDK on your
62 development machine by running the <filename>*.sh</filename> 62 <ulink url='&YOCTO_DOCS_REF_URL;#hardware-build-system-term'>Build Host</ulink>
63 installation script. 63 by running the <filename>*.sh</filename> installation script.
64 </para> 64 </para>
65 65
66 <para> 66 <para>
67 You can download a tarball installer, which includes the 67 You can download a tarball installer, which includes the
68 pre-built toolchain, the <filename>runqemu</filename> 68 pre-built toolchain, the <filename>runqemu</filename>
69 script, the internal build system, <filename>devtool</filename>, 69 script, the internal build system, <filename>devtool</filename>,
70 and support files from the appropriate directory under 70 and support files from the appropriate
71 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>. 71 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'>toolchain</ulink>
72 Toolchains are available for 32-bit and 64-bit x86 development 72 directory within the Index of Releases.
73 systems from the <filename>i686</filename> and 73 Toolchains are available for several 32-bit and 64-bit
74 <filename>x86_64</filename> directories, respectively. 74 architectures with the <filename>x86_64</filename> directories,
75 respectively.
75 The toolchains the Yocto Project provides are based off the 76 The toolchains the Yocto Project provides are based off the
76 <filename>core-image-sato</filename> image and contain 77 <filename>core-image-sato</filename> and
78 <filename>core-image-minimal</filename> images and contain
77 libraries appropriate for developing against that image. 79 libraries appropriate for developing against that image.
78 Each type of development system supports five or more target
79 architectures.
80 </para> 80 </para>
81 81
82 <para> 82 <para>
@@ -85,6 +85,7 @@
85 filename and then is immediately followed by a string 85 filename and then is immediately followed by a string
86 representing the target architecture. 86 representing the target architecture.
87 An extensible SDK has the string "-ext" as part of the name. 87 An extensible SDK has the string "-ext" as part of the name.
88 Following is the general form:
88 <literallayout class='monospaced'> 89 <literallayout class='monospaced'>
89 poky-glibc-<replaceable>host_system</replaceable>-<replaceable>image_type</replaceable>-<replaceable>arch</replaceable>-toolchain-ext-<replaceable>release_version</replaceable>.sh 90 poky-glibc-<replaceable>host_system</replaceable>-<replaceable>image_type</replaceable>-<replaceable>arch</replaceable>-toolchain-ext-<replaceable>release_version</replaceable>.sh
90 91
@@ -93,14 +94,15 @@
93 94
94 i686 or x86_64. 95 i686 or x86_64.
95 96
96 <replaceable>image_type</replaceable> is the image for which the SDK was built. 97 <replaceable>image_type</replaceable> is the image for which the SDK was built:
98
99 core-image-sato or core-image-minimal
97 100
98 <replaceable>arch</replaceable> is a string representing the tuned target architecture: 101 <replaceable>arch</replaceable> is a string representing the tuned target architecture:
99 102
100 i586, x86_64, powerpc, mips, armv7a or armv5te 103 aarch64, armv5e, core2-64, i586, mips32r2, mips64, ppc7400, or cortexa8hf-neon
101 104
102 <replaceable>release_version</replaceable> is a string representing the release number of the 105 <replaceable>release_version</replaceable> is a string representing the release number of the Yocto Project:
103 Yocto Project:
104 106
105 &DISTRO;, &DISTRO;+snapshot 107 &DISTRO;, &DISTRO;+snapshot
106 </literallayout> 108 </literallayout>
@@ -131,9 +133,10 @@
131 home directory. 133 home directory.
132 You can choose to install the extensible SDK in any location when 134 You can choose to install the extensible SDK in any location when
133 you run the installer. 135 you run the installer.
134 However, the location you choose needs to be writable for whichever 136 However, because files need to be written under that directory
135 users need to use the SDK, since files will need to be written 137 during the normal course of operation, the location you choose
136 under that directory during the normal course of operation. 138 for installation must be writable for whichever
139 users need to use the SDK.
137 </para> 140 </para>
138 141
139 <para> 142 <para>
@@ -141,28 +144,34 @@
141 toolchain tarball for a 64-bit x86 development host system and 144 toolchain tarball for a 64-bit x86 development host system and
142 a 64-bit x86 target architecture. 145 a 64-bit x86 target architecture.
143 The example assumes the SDK installer is located in 146 The example assumes the SDK installer is located in
144 <filename>~/Downloads/</filename>. 147 <filename>~/Downloads/</filename> and has execution rights.
145 <note> 148 <note>
146 If you do not have write permissions for the directory 149 If you do not have write permissions for the directory
147 into which you are installing the SDK, the installer 150 into which you are installing the SDK, the installer
148 notifies you and exits. 151 notifies you and exits.
149 Be sure you have write permissions in the directory and 152 For that case, set up the proper permissions in the directory
150 run the installer again. 153 and run the installer again.
151 </note> 154 </note>
152 <literallayout class='monospaced'> 155 <literallayout class='monospaced'>
153 $ ./poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-&DISTRO;.sh 156 $ ./Downloads/poky-glibc-x86_64-core-image-minimal-core2-64-toolchain-ext-2.5.sh
154 Poky (Yocto Project Reference Distro) Extensible SDK installer version &DISTRO; 157 Poky (Yocto Project Reference Distro) Extensible SDK installer version 2.5
155 =================================================================================== 158 ==========================================================================
156 Enter target directory for SDK (default: ~/poky_sdk): 159 Enter target directory for SDK (default: ~/poky_sdk):
157 You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed[Y/n]? Y 160 You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed[Y/n]? Y
158 Extracting SDK......................................................................done 161 Extracting SDK..............done
159 Setting it up... 162 Setting it up...
160 Extracting buildtools... 163 Extracting buildtools...
161 Preparing build system... 164 Preparing build system...
165 Parsing recipes: 100% |##################################################################| Time: 0:00:52
166 Initialising tasks: 100% |###############################################################| Time: 0:00:00
167 Checking sstate mirror object availability: 100% |#######################################| Time: 0:00:00
168 Loading cache: 100% |####################################################################| Time: 0:00:00
169 Initialising tasks: 100% |###############################################################| Time: 0:00:00
162 done 170 done
163 SDK has been successfully set up and is ready to be used. 171 SDK has been successfully set up and is ready to be used.
164 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. 172 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
165 $ . /home/scottrif/poky_sdk/environment-setup-core2-64-poky-linux 173 $ . /home/scottrif/poky_sdk/environment-setup-core2-64-poky-linux
174
166 </literallayout> 175 </literallayout>
167 </para> 176 </para>
168 </section> 177 </section>