summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-10-13 17:56:30 +0200
committerSteve Sakoman <steve@sakoman.com>2023-10-25 04:45:51 -1000
commitc969a2456c715d6adbc504977283d14a82dc342b (patch)
treecb3215937f333d203fab81578aae19ddc15b414a /documentation
parent734069e81bfc0478e991b62a473fd3fd5ae07c06 (diff)
downloadpoky-c969a2456c715d6adbc504977283d14a82dc342b.tar.gz
sdk-manual: appendix-obtain: improve and update descriptions
- Improve text formatting - Stop mentioning all possible values - Update examples - Correct descriptions (From yocto-docs rev: d44cd995e4abc1bed57a7edbe27fdfd642768d4f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/sdk-manual/appendix-obtain.rst50
1 files changed, 18 insertions, 32 deletions
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index 841abac5aa..7b458f281b 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -25,27 +25,20 @@ Follow these steps to locate and hand-install the toolchain:
25 download the installer appropriate for your build host, target 25 download the installer appropriate for your build host, target
26 hardware, and image type. 26 hardware, and image type.
27 27
28 The installer files (``*.sh``) follow this naming convention:: 28 The installer files (``*.sh``) follow this naming convention:
29 ``poky-glibc-host_system-core-image-type-arch-toolchain[-ext]-release.sh``:
29 30
30 poky-glibc-host_system-core-image-type-arch-toolchain[-ext]-release.sh 31 - ``host_system``: string representing your development system: ``i686`` or ``x86_64``
31 32
32 Where: 33 - ``type``: string representing the image: ``sato`` or ``minimal``
33 host_system is a string representing your development system:
34 "i686" or "x86_64"
35 34
36 type is a string representing the image: 35 - ``arch``: string representing the target architecture such as ``cortexa57-qemuarm64``
37 "sato" or "minimal"
38 36
39 arch is a string representing the target architecture: 37 - ``release``: version of the Yocto Project.
40 "aarch64", "armv5e", "core2-64", "cortexa8hf-neon", "i586", "mips32r2",
41 "mips64", or "ppc7400"
42
43 release is the version of Yocto Project.
44
45 NOTE:
46 The standard SDK installer does not have the "-ext" string as
47 part of the filename.
48 38
39 .. note::
40 The standard SDK installer does not have the ``-ext`` string as
41 part of the filename.
49 42
50 The toolchains provided by the Yocto 43 The toolchains provided by the Yocto
51 Project are based off of the ``core-image-sato`` and 44 Project are based off of the ``core-image-sato`` and
@@ -53,16 +46,16 @@ Follow these steps to locate and hand-install the toolchain:
53 developing against those images. 46 developing against those images.
54 47
55 For example, if your build host is a 64-bit x86 system and you need 48 For example, if your build host is a 64-bit x86 system and you need
56 an extended SDK for a 64-bit core2 target, go into the ``x86_64`` 49 an extended SDK for a 64-bit core2 QEMU target, go into the ``x86_64``
57 folder and download the following installer:: 50 folder and download the following installer::
58 51
59 poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh 52 poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
60 53
614. *Run the Installer:* Be sure you have execution privileges and run 544. *Run the Installer:* Be sure you have execution privileges and run
62 the installer. Following is an example from the ``Downloads`` 55 the installer. Following is an example from the ``Downloads``
63 directory:: 56 directory::
64 57
65 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh 58 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
66 59
67 During execution of the script, you choose the root location for the 60 During execution of the script, you choose the root location for the
68 toolchain. See the 61 toolchain. See the
@@ -206,21 +199,14 @@ Follow these steps to extract the root filesystem:
206 also contain flattened root filesystem image files (``*.ext4``), 199 also contain flattened root filesystem image files (``*.ext4``),
207 which you can use with QEMU directly. 200 which you can use with QEMU directly.
208 201
209 The pre-built root filesystem image files follow these naming 202 The pre-built root filesystem image files follow the
210 conventions:: 203 ``core-image-profile-machine.tar.bz2`` naming convention:
211
212 core-image-profile-arch.tar.bz2
213 204
214 Where: 205 - ``profile``: filesystem image's profile, such as ``minimal``,
215 profile is the filesystem image's profile: 206 ``minimal-dev`` or ``sato``. For information on these types of image
216 lsb, lsb-dev, lsb-sdk, minimal, minimal-dev, minimal-initramfs, 207 profiles, see the "Images" chapter in the Yocto Project Reference Manual.
217 sato, sato-dev, sato-sdk, sato-sdk-ptest. For information on
218 these types of image profiles, see the "Images" chapter in
219 the Yocto Project Reference Manual.
220 208
221 arch is a string representing the target architecture: 209 - ``machine``: same string as the name of the parent download directory.
222 beaglebone-yocto, beaglebone-yocto-lsb, edgerouter, edgerouter-lsb,
223 genericx86, genericx86-64, genericx86-64-lsb, genericx86-lsb and qemu*.
224 210
225 The root filesystems 211 The root filesystems
226 provided by the Yocto Project are based off of the 212 provided by the Yocto Project are based off of the