summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-10-13 17:56:30 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-10-20 14:40:29 +0100
commit373001bbc0a9482e297e072efa30b0ee12a019f4 (patch)
tree209e57946629e7e88e68bb58daf26802953628ff
parent0b3dd82d38f32735815bf799c5b45c93d515c124 (diff)
downloadpoky-373001bbc0a9482e297e072efa30b0ee12a019f4.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: f7437c2efa1014dc46481993b5e87d52dcf42b05) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-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 f40ea6d4ab..ad531cbf24 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -39,27 +39,20 @@ Follow these steps to locate and hand-install the toolchain:
39 download the installer appropriate for your build host, target 39 download the installer appropriate for your build host, target
40 hardware, and image type. 40 hardware, and image type.
41 41
42 The installer files (``*.sh``) follow this naming convention:: 42 The installer files (``*.sh``) follow this naming convention:
43 ``poky-glibc-host_system-core-image-type-arch-toolchain[-ext]-release.sh``:
43 44
44 poky-glibc-host_system-core-image-type-arch-toolchain[-ext]-release.sh 45 - ``host_system``: string representing your development system: ``i686`` or ``x86_64``
45 46
46 Where: 47 - ``type``: string representing the image: ``sato`` or ``minimal``
47 host_system is a string representing your development system:
48 "i686" or "x86_64"
49 48
50 type is a string representing the image: 49 - ``arch``: string representing the target architecture such as ``cortexa57-qemuarm64``
51 "sato" or "minimal"
52 50
53 arch is a string representing the target architecture: 51 - ``release``: version of the Yocto Project.
54 "aarch64", "armv5e", "core2-64", "cortexa8hf-neon", "i586", "mips32r2",
55 "mips64", or "ppc7400"
56
57 release is the version of Yocto Project.
58
59 NOTE:
60 The standard SDK installer does not have the "-ext" string as
61 part of the filename.
62 52
53 .. note::
54 The standard SDK installer does not have the ``-ext`` string as
55 part of the filename.
63 56
64 The toolchains provided by the Yocto 57 The toolchains provided by the Yocto
65 Project are based off of the ``core-image-sato`` and 58 Project are based off of the ``core-image-sato`` and
@@ -67,16 +60,16 @@ Follow these steps to locate and hand-install the toolchain:
67 developing against those images. 60 developing against those images.
68 61
69 For example, if your build host is a 64-bit x86 system and you need 62 For example, if your build host is a 64-bit x86 system and you need
70 an extended SDK for a 64-bit core2 target, go into the ``x86_64`` 63 an extended SDK for a 64-bit core2 QEMU target, go into the ``x86_64``
71 folder and download the following installer:: 64 folder and download the following installer::
72 65
73 poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh 66 poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
74 67
75#. *Run the Installer:* Be sure you have execution privileges and run 68#. *Run the Installer:* Be sure you have execution privileges and run
76 the installer. Following is an example from the ``Downloads`` 69 the installer. Following is an example from the ``Downloads``
77 directory:: 70 directory::
78 71
79 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh 72 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-qemux86-64-toolchain-&DISTRO;.sh
80 73
81 During execution of the script, you choose the root location for the 74 During execution of the script, you choose the root location for the
82 toolchain. See the 75 toolchain. See the
@@ -216,21 +209,14 @@ Follow these steps to extract the root filesystem:
216 also contain flattened root filesystem image files (``*.ext4``), 209 also contain flattened root filesystem image files (``*.ext4``),
217 which you can use with QEMU directly. 210 which you can use with QEMU directly.
218 211
219 The pre-built root filesystem image files follow these naming 212 The pre-built root filesystem image files follow the
220 conventions:: 213 ``core-image-profile-machine.tar.bz2`` naming convention:
221
222 core-image-profile-arch.tar.bz2
223 214
224 Where: 215 - ``profile``: filesystem image's profile, such as ``minimal``,
225 profile is the filesystem image's profile: 216 ``minimal-dev`` or ``sato``. For information on these types of image
226 lsb, lsb-dev, lsb-sdk, minimal, minimal-dev, minimal-initramfs, 217 profiles, see the "Images" chapter in the Yocto Project Reference Manual.
227 sato, sato-dev, sato-sdk, sato-sdk-ptest. For information on
228 these types of image profiles, see the "Images" chapter in
229 the Yocto Project Reference Manual.
230 218
231 arch is a string representing the target architecture: 219 - ``machine``: same string as the name of the parent download directory.
232 beaglebone-yocto, beaglebone-yocto-lsb, edgerouter, edgerouter-lsb,
233 genericx86, genericx86-64, genericx86-64-lsb, genericx86-lsb and qemu*.
234 220
235 The root filesystems 221 The root filesystems
236 provided by the Yocto Project are based off of the 222 provided by the Yocto Project are based off of the