summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2021-01-16 12:16:03 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-01-20 00:53:53 +0000
commite6a0be545d73b1052a259547afd2aa63d4b58546 (patch)
tree065e669743e2e2eb2de44e5405fb20c0b44ce4e4 /documentation
parent658499cacb252f55124a6ac0bf57ed0b145544d8 (diff)
downloadpoky-e6a0be545d73b1052a259547afd2aa63d4b58546.tar.gz
docs: fix missing & and ; surrounding references from poky.yaml
poky.yaml references are only replaced in files if they are prefixed by & and suffixed by ;. Let's fix the missing surrounding characters. (From yocto-docs rev: 7ee4ba7a27acd87d8c728639d1b053d2e26c6e58) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/kernel-dev/common.rst2
-rw-r--r--documentation/ref-manual/devtool-reference.rst8
-rw-r--r--documentation/ref-manual/release-process.rst4
-rw-r--r--documentation/ref-manual/system-requirements.rst4
-rw-r--r--documentation/ref-manual/terms.rst4
-rw-r--r--documentation/ref-manual/variables.rst4
-rw-r--r--documentation/sdk-manual/appendix-obtain.rst6
-rw-r--r--documentation/sdk-manual/extensible.rst4
-rw-r--r--documentation/sdk-manual/working-projects.rst4
9 files changed, 20 insertions, 20 deletions
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 6691da4489..58adcc9b70 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -139,7 +139,7 @@ section:
139 ~/poky/build/tmp/deploy/sdk 139 ~/poky/build/tmp/deploy/sdk
140 140
141 For this example, the installer file is named 141 For this example, the installer file is named
142 ``poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-DISTRO.sh``. 142 ``poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-&DISTRO;.sh``.
143 143
1446. *Install the Extensible SDK:* Use the following command to install 1446. *Install the Extensible SDK:* Use the following command to install
145 the SDK. For this example, install the SDK in the default 145 the SDK. For this example, install the SDK in the default
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index cc5848fd4d..5075f0c224 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -204,20 +204,20 @@ specify these options when using the ``devtool add`` command:
204- To specify a source branch, use the ``--srcbranch`` option: 204- To specify a source branch, use the ``--srcbranch`` option:
205 :: 205 ::
206 206
207 $ devtool add --srcbranch DISTRO_NAME_NO_CAP jackson /home/user/sources/jackson 207 $ devtool add --srcbranch &DISTRO_NAME_NO_CAP; jackson /home/user/sources/jackson
208 208
209 In the previous example, you are checking out the DISTRO_NAME_NO_CAP 209 In the previous example, you are checking out the &DISTRO_NAME_NO_CAP;
210 branch. 210 branch.
211 211
212- To specify a specific tag or commit hash, use the ``--srcrev`` 212- To specify a specific tag or commit hash, use the ``--srcrev``
213 option: 213 option:
214 :: 214 ::
215 215
216 $ devtool add --srcrev DISTRO_REL_TAG jackson /home/user/sources/jackson 216 $ devtool add --srcrev &DISTRO_REL_TAG; jackson /home/user/sources/jackson
217 $ devtool add --srcrev some_commit_hash /home/user/sources/jackson 217 $ devtool add --srcrev some_commit_hash /home/user/sources/jackson
218 218
219 The previous examples check out the 219 The previous examples check out the
220 DISTRO_REL_TAG tag and the commit associated with the 220 &DISTRO_REL_TAG; tag and the commit associated with the
221 some_commit_hash hash. 221 some_commit_hash hash.
222 222
223.. note:: 223.. note::
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst
index d8d362282b..ed5a09a55d 100644
--- a/documentation/ref-manual/release-process.rst
+++ b/documentation/ref-manual/release-process.rst
@@ -12,7 +12,7 @@ stability.
12Major and Minor Release Cadence 12Major and Minor Release Cadence
13=============================== 13===============================
14 14
15The Yocto Project delivers major releases (e.g. DISTRO) using a six 15The Yocto Project delivers major releases (e.g. &DISTRO;) using a six
16month cadence roughly timed each April and October of the year. 16month cadence roughly timed each April and October of the year.
17Following are examples of some major YP releases with their codenames 17Following are examples of some major YP releases with their codenames
18also shown. See the "`Major Release 18also shown. See the "`Major Release
@@ -57,7 +57,7 @@ codename are likely to be compatible and thus work together.
57.. note:: 57.. note::
58 58
59 Codenames are associated with major releases because a Yocto Project 59 Codenames are associated with major releases because a Yocto Project
60 release number (e.g. DISTRO) could conflict with a given layer or 60 release number (e.g. &DISTRO;) could conflict with a given layer or
61 company versioning scheme. Codenames are unique, interesting, and 61 company versioning scheme. Codenames are unique, interesting, and
62 easily identifiable. 62 easily identifiable.
63 63
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 66afb08102..c8c1381cb9 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -340,12 +340,12 @@ of the two methods by which you can get these tools:
340 traditional installer: 340 traditional installer:
341 :: 341 ::
342 342
343 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-DISTRO.sh 343 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
344 344
345 Here is an example for the extended installer: 345 Here is an example for the extended installer:
346 :: 346 ::
347 347
348 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-DISTRO.sh 348 $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
349 349
350 During execution, a prompt appears that allows you to choose the 350 During execution, a prompt appears that allows you to choose the
351 installation directory. For example, you could choose the following: 351 installation directory. For example, you could choose the following:
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 966962005b..bf46148876 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -90,13 +90,13 @@ universal, the list includes them just in case:
90 - Provide a directory path and specifically name the Build 90 - Provide a directory path and specifically name the Build
91 Directory. Any intermediate folders in the pathname must exist. 91 Directory. Any intermediate folders in the pathname must exist.
92 This next example creates a Build Directory named 92 This next example creates a Build Directory named
93 ``YP-POKYVERSION`` in your home directory within the existing 93 ``YP-&POKYVERSION;`` in your home directory within the existing
94 directory ``mybuilds``: 94 directory ``mybuilds``:
95 95
96 .. code-block:: shell 96 .. code-block:: shell
97 97
98 $ cd $HOME 98 $ cd $HOME
99 $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-POKYVERSION 99 $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-&POKYVERSION;
100 100
101 .. note:: 101 .. note::
102 102
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 4ce2648136..5ec19970e4 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4202,11 +4202,11 @@ system and gives an overview of their function and contents.
4202 this variable in your layer's ``conf/layer.conf`` configuration file. 4202 this variable in your layer's ``conf/layer.conf`` configuration file.
4203 For the list, use the Yocto Project 4203 For the list, use the Yocto Project
4204 :yocto_wiki:`Release Name </Releases>` (e.g. 4204 :yocto_wiki:`Release Name </Releases>` (e.g.
4205 DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the 4205 &DISTRO_NAME_NO_CAP;). To specify multiple OE-Core versions for the
4206 layer, use a space-separated list: 4206 layer, use a space-separated list:
4207 :: 4207 ::
4208 4208
4209 LAYERSERIES_COMPAT_layer_root_name = "DISTRO_NAME_NO_CAP DISTRO_NAME_NO_CAP_MINUS_ONE" 4209 LAYERSERIES_COMPAT_layer_root_name = "&DISTRO_NAME_NO_CAP; &DISTRO_NAME_NO_CAP_MINUS_ONE;"
4210 4210
4211 .. note:: 4211 .. note::
4212 4212
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index cdfe2cc85e..f158c244ab 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -58,14 +58,14 @@ Follow these steps to locate and hand-install the toolchain:
58 folder and download the following installer: 58 folder and download the following installer:
59 :: 59 ::
60 60
61 poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-DISTRO.sh 61 poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
62 62
634. *Run the Installer:* Be sure you have execution privileges and run 634. *Run the Installer:* Be sure you have execution privileges and run
64 the installer. Following is an example from the ``Downloads`` 64 the installer. Following is an example from the ``Downloads``
65 directory: 65 directory:
66 :: 66 ::
67 67
68 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-DISTRO.sh 68 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
69 69
70 During execution of the script, you choose the root location for the 70 During execution of the script, you choose the root location for the
71 toolchain. See the "`Installed Standard SDK Directory 71 toolchain. See the "`Installed Standard SDK Directory
@@ -174,7 +174,7 @@ build the SDK installer. Follow these steps:
174 :: 174 ::
175 175
176 $ cd ~/poky/build/tmp/deploy/sdk 176 $ cd ~/poky/build/tmp/deploy/sdk
177 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-DISTRO.sh 177 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
178 178
179 During execution of the script, you choose the root location for the 179 During execution of the script, you choose the root location for the
180 toolchain. See the "`Installed Standard SDK Directory 180 toolchain. See the "`Installed Standard SDK Directory
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index c94213d6ca..5962e9460a 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -82,10 +82,10 @@ is the general form:
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
85the SDK for ``core-image-sato`` and using the current DISTRO snapshot: 85the SDK for ``core-image-sato`` and using the current &DISTRO; snapshot:
86:: 86::
87 87
88 poky-glibc-x86_64-core-image-sato-i586-toolchain-ext-DISTRO.sh 88 poky-glibc-x86_64-core-image-sato-i586-toolchain-ext-&DISTRO;.sh
89 89
90.. note:: 90.. note::
91 91
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst
index 3e40936ff6..bddf00a7dc 100644
--- a/documentation/sdk-manual/working-projects.rst
+++ b/documentation/sdk-manual/working-projects.rst
@@ -292,11 +292,11 @@ example:
292 the string "environment-setup" and contains the machine architecture, 292 the string "environment-setup" and contains the machine architecture,
293 which is followed by the string "poky-linux". For this example, the 293 which is followed by the string "poky-linux". For this example, the
294 command sources a script from the default SDK installation directory 294 command sources a script from the default SDK installation directory
295 that uses the 32-bit Intel x86 Architecture and the DISTRO_NAME Yocto 295 that uses the 32-bit Intel x86 Architecture and the &DISTRO_NAME; Yocto
296 Project release: 296 Project release:
297 :: 297 ::
298 298
299 $ source /opt/poky/DISTRO/environment-setup-i586-poky-linux 299 $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
300 300
3013. *Create the Makefile:* For this example, the Makefile contains 3013. *Create the Makefile:* For this example, the Makefile contains
302 two lines that can be used to set the ``CC`` variable. One line is 302 two lines that can be used to set the ``CC`` variable. One line is