summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-05-31 15:51:35 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-06-15 11:26:46 +0100
commit3a6a32df9761c734412910f9a0823e9ee9a52b2b (patch)
tree3b0ad75d87712338a17279c0ccf6fdf26b636d06 /documentation
parent4d586da1083d70b0d370310d4dd05f6b1b391a62 (diff)
downloadpoky-3a6a32df9761c734412910f9a0823e9ee9a52b2b.tar.gz
sdk-manual: Edits to standard SDK intro and install sections
Changed the output to reflect the real command's output. Updated prose to match (mostly) that used in the similar extensible SDK sections. (From yocto-docs rev: fb6c8895f2afda0c43bbaa49870c425e25841ec4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/sdk-manual/sdk-using.xml54
1 files changed, 26 insertions, 28 deletions
diff --git a/documentation/sdk-manual/sdk-using.xml b/documentation/sdk-manual/sdk-using.xml
index c90620e8dc..c7046d63a7 100644
--- a/documentation/sdk-manual/sdk-using.xml
+++ b/documentation/sdk-manual/sdk-using.xml
@@ -53,24 +53,24 @@
53 <title>Installing the SDK</title> 53 <title>Installing the SDK</title>
54 54
55 <para> 55 <para>
56 The first thing you need to do is install the SDK on your host 56 The first thing you need to do is install the SDK on your
57 development machine by running the <filename>*.sh</filename> 57 <ulink url='&YOCTO_DOCS_REF_URL;#hardware-build-system-term'>Build Host</ulink>
58 installation script. 58 by running the <filename>*.sh</filename> installation script.
59 </para> 59 </para>
60 60
61 <para> 61 <para>
62 You can download a tarball installer, which includes the 62 You can download a tarball installer, which includes the
63 pre-built toolchain, the <filename>runqemu</filename> 63 pre-built toolchain, the <filename>runqemu</filename>
64 script, and support files from the appropriate directory under 64 script, and support files from the appropriate
65 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>. 65 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'>toolchain</ulink>
66 Toolchains are available for 32-bit and 64-bit x86 development 66 directory within the Index of Releases.
67 systems from the <filename>i686</filename> and 67 Toolchains are available for several 32-bit and 64-bit
68 <filename>x86_64</filename> directories, respectively. 68 architectures with the <filename>x86_64</filename> directories,
69 respectively.
69 The toolchains the Yocto Project provides are based off the 70 The toolchains the Yocto Project provides are based off the
70 <filename>core-image-sato</filename> image and contain 71 <filename>core-image-sato</filename> and
72 <filename>core-image-minimal</filename> images and contain
71 libraries appropriate for developing against that image. 73 libraries appropriate for developing against that image.
72 Each type of development system supports five or more target
73 architectures.
74 </para> 74 </para>
75 75
76 <para> 76 <para>
@@ -92,7 +92,7 @@
92 92
93 <replaceable>arch</replaceable> is a string representing the tuned target architecture: 93 <replaceable>arch</replaceable> is a string representing the tuned target architecture:
94 94
95 aarch64, armv5e, core2-64, coretexah8f-neon, i586, mips32r2, mips64, or ppc7400. 95 aarch64, armv5e, core2-64, i586, mips32r2, mips64, ppc7400, or cortexa8hf-neon.
96 96
97 <replaceable>release_version</replaceable> is a string representing the release number of the Yocto Project: 97 <replaceable>release_version</replaceable> is a string representing the release number of the Yocto Project:
98 98
@@ -121,38 +121,36 @@
121 121
122 <para> 122 <para>
123 The SDK and toolchains are self-contained and by default are 123 The SDK and toolchains are self-contained and by default are
124 installed into <filename>/opt/poky</filename>. 124 installed into the <filename>poky_sdk</filename> folder in your
125 However, when you run the SDK installer, you can choose an 125 home directory.
126 installation directory. 126 You can choose to install the extensible SDK in any location when
127 <note> 127 you run the installer.
128 You must change the permissions on the SDK 128 However, because files need to be written under that directory
129 installer script so that it is executable: 129 during the normal course of operation, the location you choose
130 <literallayout class='monospaced'> 130 for installation must be writable for whichever
131 $ chmod +x poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh 131 users need to use the SDK.
132 </literallayout>
133 </note>
134 </para> 132 </para>
135 133
136 <para> 134 <para>
137 The following command shows how to run the installer given a 135 The following command shows how to run the installer given a
138 toolchain tarball for a 64-bit x86 development host system and 136 toolchain tarball for a 64-bit x86 development host system and
139 a 32-bit x86 target architecture. 137 a 64-bit x86 target architecture.
140 The example assumes the SDK installer is located in 138 The example assumes the SDK installer is located in
141 <filename>~/Downloads/</filename>. 139 <filename>~/Downloads/</filename> and has execution rights.
142 <note> 140 <note>
143 If you do not have write permissions for the directory 141 If you do not have write permissions for the directory
144 into which you are installing the SDK, the installer 142 into which you are installing the SDK, the installer
145 notifies you and exits. 143 notifies you and exits.
146 Be sure you have write permissions in the directory and 144 For that case, set up the proper permissions in the directory
147 run the installer again. 145 and run the installer again.
148 </note> 146 </note>
149 <literallayout class='monospaced'> 147 <literallayout class='monospaced'>
150 $ ./poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh 148 $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
151 Poky (Yocto Project Reference Distro) SDK installer version &DISTRO; 149 Poky (Yocto Project Reference Distro) SDK installer version &DISTRO;
152 =============================================================== 150 ===============================================================
153 Enter target directory for SDK (default: /opt/poky/&DISTRO;): 151 Enter target directory for SDK (default: /opt/poky/&DISTRO;):
154 You are about to install the SDK to "/opt/poky/&DISTRO;". Proceed[Y/n]? Y 152 You are about to install the SDK to "/opt/poky/&DISTRO;". Proceed[Y/n]? Y
155 Extracting SDK.......................................................................done 153 Extracting SDK........................................ ..............................done
156 Setting it up...done 154 Setting it up...done
157 SDK has been successfully set up and is ready to be used. 155 SDK has been successfully set up and is ready to be used.
158 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. 156 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.