summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-11-25 09:33:33 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-03 12:04:20 +0000
commit912a3c52e26e4bae8222138f291a86c61838506e (patch)
treee731578da3feafcf6132af513c3709fc58b02fc0 /documentation
parentf70c628ae57bb0c98e74e5646a2ee61cee34403e (diff)
downloadpoky-912a3c52e26e4bae8222138f291a86c61838506e.tar.gz
{dev,kernel,sdk}-manual: replace hardcoded release version with &DISTRO;
In the Docbook files we had DISTRO, but somehow it was lost during the migration to Sphinx. (From yocto-docs rev: d10bb13070039e17281fccc5c1a64b5bfed30543) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-qemu.rst2
-rw-r--r--documentation/kernel-dev/kernel-dev-common.rst4
-rw-r--r--documentation/sdk-manual/sdk-appendix-obtain.rst8
-rw-r--r--documentation/sdk-manual/sdk-extensible.rst4
-rw-r--r--documentation/sdk-manual/sdk-intro.rst4
-rw-r--r--documentation/sdk-manual/sdk-using.rst18
-rw-r--r--documentation/sdk-manual/sdk-working-projects.rst10
7 files changed, 25 insertions, 25 deletions
diff --git a/documentation/dev-manual/dev-manual-qemu.rst b/documentation/dev-manual/dev-manual-qemu.rst
index c91e8b5389..63640411d4 100644
--- a/documentation/dev-manual/dev-manual-qemu.rst
+++ b/documentation/dev-manual/dev-manual-qemu.rst
@@ -81,7 +81,7 @@ available. Follow these general steps to run QEMU:
81 your :term:`Build Directory`. 81 your :term:`Build Directory`.
82 82
83 - If you have not built an image, you can go to the 83 - If you have not built an image, you can go to the
84 :yocto_dl:`machines/qemu </releases/yocto/yocto-3.1.2/machines/qemu/>` area and download a 84 :yocto_dl:`machines/qemu </releases/yocto/yocto-&DISTRO;/machines/qemu/>` area and download a
85 pre-built image that matches your architecture and can be run on 85 pre-built image that matches your architecture and can be run on
86 QEMU. 86 QEMU.
87 87
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst
index 72d9d78796..e548fa3a9d 100644
--- a/documentation/kernel-dev/kernel-dev-common.rst
+++ b/documentation/kernel-dev/kernel-dev-common.rst
@@ -147,8 +147,8 @@ section:
147 :: 147 ::
148 148
149 $ cd ~/poky/build/tmp/deploy/sdk 149 $ cd ~/poky/build/tmp/deploy/sdk
150 $ ./poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-3.1.2.sh 150 $ ./poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-&DISTRO;.sh
151 Poky (Yocto Project Reference Distro) Extensible SDK installer version 3.1.2 151 Poky (Yocto Project Reference Distro) Extensible SDK installer version &DISTRO;
152 ============================================================================ 152 ============================================================================
153 Enter target directory for SDK (default: ~/poky_sdk): 153 Enter target directory for SDK (default: ~/poky_sdk):
154 You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y 154 You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.rst b/documentation/sdk-manual/sdk-appendix-obtain.rst
index eef425bdf0..1a2e4c387b 100644
--- a/documentation/sdk-manual/sdk-appendix-obtain.rst
+++ b/documentation/sdk-manual/sdk-appendix-obtain.rst
@@ -15,7 +15,7 @@ and then run the script to hand-install the toolchain.
15Follow these steps to locate and hand-install the toolchain: 15Follow these steps to locate and hand-install the toolchain:
16 16
171. *Go to the Installers Directory:* Go to 171. *Go to the Installers Directory:* Go to
18 :yocto_dl:`/releases/yocto/yocto-3.1.2/toolchain/` 18 :yocto_dl:`/releases/yocto/yocto-&DISTRO;/toolchain/`
19 19
202. *Open the Folder for Your Build Host:* Open the folder that matches 202. *Open the Folder for Your Build Host:* Open the folder that matches
21 your :term:`Build Host` (i.e. 21 your :term:`Build Host` (i.e.
@@ -202,7 +202,7 @@ Follow these steps to extract the root filesystem:
202 Image File:* You need to find and download the root filesystem image 202 Image File:* You need to find and download the root filesystem image
203 file that is appropriate for your target system. These files are kept 203 file that is appropriate for your target system. These files are kept
204 in machine-specific folders in the 204 in machine-specific folders in the
205 :yocto_dl:`Index of Releases </releases/yocto/yocto-3.1.2/machines/>` 205 :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`
206 in the "machines" directory. 206 in the "machines" directory.
207 207
208 The machine-specific folders of the "machines" directory contain 208 The machine-specific folders of the "machines" directory contain
@@ -256,7 +256,7 @@ Follow these steps to extract the root filesystem:
256 256
257 Following is an example command that extracts the root filesystem 257 Following is an example command that extracts the root filesystem
258 from a previously built root filesystem image that was downloaded 258 from a previously built root filesystem image that was downloaded
259 from the :yocto_dl:`Index of Releases </releases/yocto/yocto-3.1.2/machines/>`. 259 from the :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`.
260 This command extracts the root filesystem into the ``core2-64-sato`` 260 This command extracts the root filesystem into the ``core2-64-sato``
261 directory: 261 directory:
262 :: 262 ::
@@ -285,7 +285,7 @@ Within the figure, italicized text is used to indicate replaceable
285portions of the file or directory name. For example, install_dir/version 285portions of the file or directory name. For example, install_dir/version
286is the directory where the SDK is installed. By default, this directory 286is the directory where the SDK is installed. By default, this directory
287is ``/opt/poky/``. And, version represents the specific snapshot of the 287is ``/opt/poky/``. And, version represents the specific snapshot of the
288SDK (e.g. 3.1.2). Furthermore, target represents the target architecture 288SDK (e.g. &DISTRO;). Furthermore, target represents the target architecture
289(e.g. ``i586``) and host represents the development system's 289(e.g. ``i586``) and host represents the development system's
290architecture (e.g. ``x86_64``). Thus, the complete names of the two 290architecture (e.g. ``x86_64``). Thus, the complete names of the two
291directories within the ``sysroots`` could be ``i586-poky-linux`` and 291directories within the ``sysroots`` could be ``i586-poky-linux`` and
diff --git a/documentation/sdk-manual/sdk-extensible.rst b/documentation/sdk-manual/sdk-extensible.rst
index 10e4d20611..1a17da4f6e 100644
--- a/documentation/sdk-manual/sdk-extensible.rst
+++ b/documentation/sdk-manual/sdk-extensible.rst
@@ -47,7 +47,7 @@ Host` by running the ``*.sh`` installation script.
47You can download a tarball installer, which includes the pre-built 47You can download a tarball installer, which includes the pre-built
48toolchain, the ``runqemu`` script, the internal build system, 48toolchain, the ``runqemu`` script, the internal build system,
49``devtool``, and support files from the appropriate 49``devtool``, and support files from the appropriate
50:yocto_dl:`toolchain </releases/yocto/yocto-3.1.2/toolchain/>` directory within the Index of 50:yocto_dl:`toolchain </releases/yocto/yocto-&DISTRO;/toolchain/>` directory within the Index of
51Releases. Toolchains are available for several 32-bit and 64-bit 51Releases. Toolchains are available for several 32-bit and 64-bit
52architectures with the ``x86_64`` directories, respectively. The 52architectures with the ``x86_64`` directories, respectively. The
53toolchains the Yocto Project provides are based off the 53toolchains the Yocto Project provides are based off the
@@ -78,7 +78,7 @@ is the general form:
78 78
79 release_version is a string representing the release number of the Yocto Project: 79 release_version is a string representing the release number of the Yocto Project:
80 80
81 3.1.2, 3.1.2+snapshot 81 &DISTRO;, &DISTRO;+snapshot
82 82
83For example, the following SDK installer is for a 64-bit 83For example, the following SDK installer is for a 64-bit
84development host system and a i586-tuned target architecture based off 84development host system and a i586-tuned target architecture based off
diff --git a/documentation/sdk-manual/sdk-intro.rst b/documentation/sdk-manual/sdk-intro.rst
index ca6138cce3..bbd33b8a78 100644
--- a/documentation/sdk-manual/sdk-intro.rst
+++ b/documentation/sdk-manual/sdk-intro.rst
@@ -184,7 +184,7 @@ You just need to follow these general steps:
184 root filesystem images. 184 root filesystem images.
185 185
186 If you are going to develop your application on hardware, go to the 186 If you are going to develop your application on hardware, go to the
187 :yocto_dl:`machines </releases/yocto/yocto-3.1.2/machines/>` download area and choose a 187 :yocto_dl:`machines </releases/yocto/yocto-&DISTRO;/machines/>` download area and choose a
188 target machine area from which to download the kernel image and root 188 target machine area from which to download the kernel image and root
189 filesystem. This download area could have several files in it that 189 filesystem. This download area could have several files in it that
190 support development using actual hardware. For example, the area 190 support development using actual hardware. For example, the area
@@ -194,7 +194,7 @@ You just need to follow these general steps:
194 194
195 If you are going to develop your application and then run and test it 195 If you are going to develop your application and then run and test it
196 using the QEMU emulator, go to the 196 using the QEMU emulator, go to the
197 :yocto_dl:`machines/qemu </releases/yocto/yocto-3.1.2/machines/qemu>` download area. From this 197 :yocto_dl:`machines/qemu </releases/yocto/yocto-&DISTRO;/machines/qemu>` download area. From this
198 area, go down into the directory for your target architecture (e.g. 198 area, go down into the directory for your target architecture (e.g.
199 ``qemux86_64`` for an Intel-based 64-bit architecture). Download the 199 ``qemux86_64`` for an Intel-based 64-bit architecture). Download the
200 kernel, root filesystem, and any other files you need for your 200 kernel, root filesystem, and any other files you need for your
diff --git a/documentation/sdk-manual/sdk-using.rst b/documentation/sdk-manual/sdk-using.rst
index 3a1cae773f..29fb50465f 100644
--- a/documentation/sdk-manual/sdk-using.rst
+++ b/documentation/sdk-manual/sdk-using.rst
@@ -43,7 +43,7 @@ Host` by running the ``*.sh`` installation script.
43 43
44You can download a tarball installer, which includes the pre-built 44You can download a tarball installer, which includes the pre-built
45toolchain, the ``runqemu`` script, and support files from the 45toolchain, the ``runqemu`` script, and support files from the
46appropriate :yocto_dl:`toolchain </releases/yocto/yocto-3.1.2/toolchain/>` directory within 46appropriate :yocto_dl:`toolchain </releases/yocto/yocto-&DISTRO;/toolchain/>` directory within
47the Index of Releases. Toolchains are available for several 32-bit and 47the Index of Releases. Toolchains are available for several 32-bit and
4864-bit architectures with the ``x86_64`` directories, respectively. The 4864-bit architectures with the ``x86_64`` directories, respectively. The
49toolchains the Yocto Project provides are based off the 49toolchains the Yocto Project provides are based off the
@@ -72,7 +72,7 @@ immediately followed by a string representing the target architecture.
72 72
73 release_version is a string representing the release number of the Yocto Project: 73 release_version is a string representing the release number of the Yocto Project:
74 74
75 3.1.2, 3.1.2+snapshot 75 &DISTRO;, &DISTRO;+snapshot
76 76
77For example, the following SDK installer is for a 64-bit 77For example, the following SDK installer is for a 64-bit
78development host system and a i586-tuned target architecture based off 78development host system and a i586-tuned target architecture based off
@@ -109,16 +109,16 @@ architecture. The example assumes the SDK installer is located in
109 109
110:: 110::
111 111
112 $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-3.1.2.sh 112 $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
113 Poky (Yocto Project Reference Distro) SDK installer version 3.1.2 113 Poky (Yocto Project Reference Distro) SDK installer version &DISTRO;
114 =============================================================== 114 ===============================================================
115 Enter target directory for SDK (default: /opt/poky/3.1.2): 115 Enter target directory for SDK (default: /opt/poky/&DISTRO;):
116 You are about to install the SDK to "/opt/poky/3.1.2". Proceed [Y/n]? Y 116 You are about to install the SDK to "/opt/poky/&DISTRO;". Proceed [Y/n]? Y
117 Extracting SDK........................................ ..............................done 117 Extracting SDK........................................ ..............................done
118 Setting it up...done 118 Setting it up...done
119 SDK has been successfully set up and is ready to be used. 119 SDK has been successfully set up and is ready to be used.
120 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. 120 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
121 $ . /opt/poky/3.1.2/environment-setup-i586-poky-linux 121 $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
122 122
123Again, reference the "`Installed Standard SDK Directory 123Again, reference the "`Installed Standard SDK Directory
124Structure <#sdk-installed-standard-sdk-directory-structure>`__" section 124Structure <#sdk-installed-standard-sdk-directory-structure>`__" section
@@ -131,7 +131,7 @@ Running the SDK Environment Setup Script
131Once you have the SDK installed, you must run the SDK environment setup 131Once you have the SDK installed, you must run the SDK environment setup
132script before you can actually use the SDK. This setup script resides in 132script before you can actually use the SDK. This setup script resides in
133the directory you chose when you installed the SDK, which is either the 133the directory you chose when you installed the SDK, which is either the
134default ``/opt/poky/3.1.2`` directory or the directory you chose during 134default ``/opt/poky/&DISTRO;`` directory or the directory you chose during
135installation. 135installation.
136 136
137Before running the script, be sure it is the one that matches the 137Before running the script, be sure it is the one that matches the
@@ -143,7 +143,7 @@ then source the environment setup script. In this example, the setup
143script is for an IA-based target machine using i586 tuning: 143script is for an IA-based target machine using i586 tuning:
144:: 144::
145 145
146 $ source /opt/poky/3.1.2/environment-setup-i586-poky-linux 146 $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
147 147
148When you run the 148When you run the
149setup script, the same environment variables are defined as are when you 149setup script, the same environment variables are defined as are when you
diff --git a/documentation/sdk-manual/sdk-working-projects.rst b/documentation/sdk-manual/sdk-working-projects.rst
index 5c828fd586..4f97640327 100644
--- a/documentation/sdk-manual/sdk-working-projects.rst
+++ b/documentation/sdk-manual/sdk-working-projects.rst
@@ -86,11 +86,11 @@ project:
86 the string "environment-setup" and contains the machine architecture, 86 the string "environment-setup" and contains the machine architecture,
87 which is followed by the string "poky-linux". For this example, the 87 which is followed by the string "poky-linux". For this example, the
88 command sources a script from the default SDK installation directory 88 command sources a script from the default SDK installation directory
89 that uses the 32-bit Intel x86 Architecture and the 3.1.2 Yocto 89 that uses the 32-bit Intel x86 Architecture and the &DISTRO; Yocto
90 Project release: 90 Project release:
91 :: 91 ::
92 92
93 $ source /opt/poky/3.1.2/environment-setup-i586-poky-linux 93 $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
94 94
953. *Create the configure Script:* Use the ``autoreconf`` command to 953. *Create the configure Script:* Use the ``autoreconf`` command to
96 generate the ``configure`` script. 96 generate the ``configure`` script.
@@ -229,14 +229,14 @@ a null value for the compiler variable (i.e.
229 229
230Running the 230Running the
231SDK setup script for a 64-bit build host and an i586-tuned target 231SDK setup script for a 64-bit build host and an i586-tuned target
232architecture for a ``core-image-sato`` image using the current 3.1.2 232architecture for a ``core-image-sato`` image using the current &DISTRO;
233Yocto Project release and then echoing that variable shows the value 233Yocto Project release and then echoing that variable shows the value
234established through the script: 234established through the script:
235:: 235::
236 236
237 $ source /opt/poky/3.1.2/environment-setup-i586-poky-linux 237 $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
238 $ echo ${CC} 238 $ echo ${CC}
239 i586-poky-linux-gcc -m32 -march=i586 --sysroot=/opt/poky/3.1.2/sysroots/i586-poky-linux 239 i586-poky-linux-gcc -m32 -march=i586 --sysroot=/opt/poky/&DISTRO;/sysroots/i586-poky-linux
240 240
241To illustrate variable use, work through this simple "Hello World!" 241To illustrate variable use, work through this simple "Hello World!"
242example: 242example: