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>
This commit is contained in:
Quentin Schulz
2021-01-16 12:16:03 +01:00
committed by Richard Purdie
parent 658499cacb
commit e6a0be545d
9 changed files with 20 additions and 20 deletions

View File

@@ -139,7 +139,7 @@ section:
~/poky/build/tmp/deploy/sdk ~/poky/build/tmp/deploy/sdk
For this example, the installer file is named For this example, the installer file is named
``poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-DISTRO.sh``. ``poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-&DISTRO;.sh``.
6. *Install the Extensible SDK:* Use the following command to install 6. *Install the Extensible SDK:* Use the following command to install
the SDK. For this example, install the SDK in the default the SDK. For this example, install the SDK in the default

View File

@@ -204,20 +204,20 @@ specify these options when using the ``devtool add`` command:
- To specify a source branch, use the ``--srcbranch`` option: - To specify a source branch, use the ``--srcbranch`` option:
:: ::
$ devtool add --srcbranch DISTRO_NAME_NO_CAP jackson /home/user/sources/jackson $ devtool add --srcbranch &DISTRO_NAME_NO_CAP; jackson /home/user/sources/jackson
In the previous example, you are checking out the DISTRO_NAME_NO_CAP In the previous example, you are checking out the &DISTRO_NAME_NO_CAP;
branch. branch.
- To specify a specific tag or commit hash, use the ``--srcrev`` - To specify a specific tag or commit hash, use the ``--srcrev``
option: option:
:: ::
$ devtool add --srcrev DISTRO_REL_TAG jackson /home/user/sources/jackson $ devtool add --srcrev &DISTRO_REL_TAG; jackson /home/user/sources/jackson
$ devtool add --srcrev some_commit_hash /home/user/sources/jackson $ devtool add --srcrev some_commit_hash /home/user/sources/jackson
The previous examples check out the The previous examples check out the
DISTRO_REL_TAG tag and the commit associated with the &DISTRO_REL_TAG; tag and the commit associated with the
some_commit_hash hash. some_commit_hash hash.
.. note:: .. note::

View File

@@ -12,7 +12,7 @@ stability.
Major and Minor Release Cadence Major and Minor Release Cadence
=============================== ===============================
The Yocto Project delivers major releases (e.g. DISTRO) using a six The Yocto Project delivers major releases (e.g. &DISTRO;) using a six
month cadence roughly timed each April and October of the year. month cadence roughly timed each April and October of the year.
Following are examples of some major YP releases with their codenames Following are examples of some major YP releases with their codenames
also shown. See the "`Major Release also shown. See the "`Major Release
@@ -57,7 +57,7 @@ codename are likely to be compatible and thus work together.
.. note:: .. note::
Codenames are associated with major releases because a Yocto Project Codenames are associated with major releases because a Yocto Project
release number (e.g. DISTRO) could conflict with a given layer or release number (e.g. &DISTRO;) could conflict with a given layer or
company versioning scheme. Codenames are unique, interesting, and company versioning scheme. Codenames are unique, interesting, and
easily identifiable. easily identifiable.

View File

@@ -340,12 +340,12 @@ of the two methods by which you can get these tools:
traditional installer: traditional installer:
:: ::
$ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-DISTRO.sh $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
Here is an example for the extended installer: Here is an example for the extended installer:
:: ::
$ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-DISTRO.sh $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
During execution, a prompt appears that allows you to choose the During execution, a prompt appears that allows you to choose the
installation directory. For example, you could choose the following: installation directory. For example, you could choose the following:

View File

@@ -90,13 +90,13 @@ universal, the list includes them just in case:
- Provide a directory path and specifically name the Build - Provide a directory path and specifically name the Build
Directory. Any intermediate folders in the pathname must exist. Directory. Any intermediate folders in the pathname must exist.
This next example creates a Build Directory named This next example creates a Build Directory named
``YP-POKYVERSION`` in your home directory within the existing ``YP-&POKYVERSION;`` in your home directory within the existing
directory ``mybuilds``: directory ``mybuilds``:
.. code-block:: shell .. code-block:: shell
$ cd $HOME $ cd $HOME
$ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-POKYVERSION $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-&POKYVERSION;
.. note:: .. note::

View File

@@ -4202,11 +4202,11 @@ system and gives an overview of their function and contents.
this variable in your layer's ``conf/layer.conf`` configuration file. this variable in your layer's ``conf/layer.conf`` configuration file.
For the list, use the Yocto Project For the list, use the Yocto Project
:yocto_wiki:`Release Name </Releases>` (e.g. :yocto_wiki:`Release Name </Releases>` (e.g.
DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the &DISTRO_NAME_NO_CAP;). To specify multiple OE-Core versions for the
layer, use a space-separated list: layer, use a space-separated list:
:: ::
LAYERSERIES_COMPAT_layer_root_name = "DISTRO_NAME_NO_CAP DISTRO_NAME_NO_CAP_MINUS_ONE" LAYERSERIES_COMPAT_layer_root_name = "&DISTRO_NAME_NO_CAP; &DISTRO_NAME_NO_CAP_MINUS_ONE;"
.. note:: .. note::

View File

@@ -58,14 +58,14 @@ Follow these steps to locate and hand-install the toolchain:
folder and download the following installer: folder and download the following installer:
:: ::
poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-DISTRO.sh poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
4. *Run the Installer:* Be sure you have execution privileges and run 4. *Run the Installer:* Be sure you have execution privileges and run
the installer. Following is an example from the ``Downloads`` the installer. Following is an example from the ``Downloads``
directory: directory:
:: ::
$ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-DISTRO.sh $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
During execution of the script, you choose the root location for the During execution of the script, you choose the root location for the
toolchain. See the "`Installed Standard SDK Directory toolchain. See the "`Installed Standard SDK Directory
@@ -174,7 +174,7 @@ build the SDK installer. Follow these steps:
:: ::
$ cd ~/poky/build/tmp/deploy/sdk $ cd ~/poky/build/tmp/deploy/sdk
$ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-DISTRO.sh $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
During execution of the script, you choose the root location for the During execution of the script, you choose the root location for the
toolchain. See the "`Installed Standard SDK Directory toolchain. See the "`Installed Standard SDK Directory

View File

@@ -82,10 +82,10 @@ is the general form:
For example, the following SDK installer is for a 64-bit For example, the following SDK installer is for a 64-bit
development host system and a i586-tuned target architecture based off development host system and a i586-tuned target architecture based off
the SDK for ``core-image-sato`` and using the current DISTRO snapshot: the SDK for ``core-image-sato`` and using the current &DISTRO; snapshot:
:: ::
poky-glibc-x86_64-core-image-sato-i586-toolchain-ext-DISTRO.sh poky-glibc-x86_64-core-image-sato-i586-toolchain-ext-&DISTRO;.sh
.. note:: .. note::

View File

@@ -292,11 +292,11 @@ example:
the string "environment-setup" and contains the machine architecture, the string "environment-setup" and contains the machine architecture,
which is followed by the string "poky-linux". For this example, the which is followed by the string "poky-linux". For this example, the
command sources a script from the default SDK installation directory command sources a script from the default SDK installation directory
that uses the 32-bit Intel x86 Architecture and the DISTRO_NAME Yocto that uses the 32-bit Intel x86 Architecture and the &DISTRO_NAME; Yocto
Project release: Project release:
:: ::
$ source /opt/poky/DISTRO/environment-setup-i586-poky-linux $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
3. *Create the Makefile:* For this example, the Makefile contains 3. *Create the Makefile:* For this example, the Makefile contains
two lines that can be used to set the ``CC`` variable. One line is two lines that can be used to set the ``CC`` variable. One line is