diff options
author | Quentin Schulz <foss@0leil.net> | 2021-01-16 12:16:03 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-20 00:53:53 +0000 |
commit | e6a0be545d73b1052a259547afd2aa63d4b58546 (patch) | |
tree | 065e669743e2e2eb2de44e5405fb20c0b44ce4e4 /documentation/ref-manual | |
parent | 658499cacb252f55124a6ac0bf57ed0b145544d8 (diff) | |
download | poky-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/ref-manual')
-rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 8 | ||||
-rw-r--r-- | documentation/ref-manual/release-process.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/system-requirements.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/terms.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 4 |
5 files changed, 12 insertions, 12 deletions
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. | |||
12 | Major and Minor Release Cadence | 12 | Major and Minor Release Cadence |
13 | =============================== | 13 | =============================== |
14 | 14 | ||
15 | The Yocto Project delivers major releases (e.g. DISTRO) using a six | 15 | The Yocto Project delivers major releases (e.g. &DISTRO;) using a six |
16 | month cadence roughly timed each April and October of the year. | 16 | month cadence roughly timed each April and October of the year. |
17 | Following are examples of some major YP releases with their codenames | 17 | Following are examples of some major YP releases with their codenames |
18 | also shown. See the "`Major Release | 18 | also 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 | ||