mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-09-29 07:36:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry

Browse Source 
Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and
adjust the opening statement to read slightly better.

(From yocto-docs rev: c1c0b3600f2f6e752faacfc877b80c2dda7cf522)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton
2021-04-12 16:19:55 +12:00
committed by Richard Purdie
parent 71b78ef384
commit 70441f2b73
1 changed files with 20 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
documentation/ref-manual/variables.rst
View File

@@ -5798,10 +5798,11 @@ system and gives an overview of their function and contents.
exclusive alternative providers. exclusive alternative providers.
:term:`PREFERRED_VERSION` :term:`PREFERRED_VERSION`
If multiple versions of recipes exist, this variable determines which If there are multiple versions of a recipe available, this variable
version is given preference. You must always suffix the variable with determines which version should be given preference. You must always
the :term:`PN` you want to select, and you should set the suffix the variable with the :term:`PN` you want to select (`python` in
:term:`PV` accordingly for precedence. the first example below), and you should specify the :term:`PV`
accordingly (`3.4.0` in the example).
The ``PREFERRED_VERSION`` variable supports limited wildcard use The ``PREFERRED_VERSION`` variable supports limited wildcard use
through the "``%``" character. You can use the character to match any through the "``%``" character. You can use the character to match any
@@ -5859,6 +5860,10 @@ system and gives an overview of their function and contents.
The ``\_forcevariable`` override is not handled specially. This override The ``\_forcevariable`` override is not handled specially. This override
only works because the default value of ``OVERRIDES`` includes "forcevariable". only works because the default value of ``OVERRIDES`` includes "forcevariable".
If a recipe with the specified version is not available, a warning
message will be shown. See :term:`REQUIRED_VERSION` if you want this
to be an error instead.
:term:`PREMIRRORS` :term:`PREMIRRORS`
Specifies additional paths from which the OpenEmbedded build system Specifies additional paths from which the OpenEmbedded build system
gets source code. When the build system searches for source code, it gets source code. When the build system searches for source code, it
@@ -6216,6 +6221,17 @@ system and gives an overview of their function and contents.
the recipe will be skipped, and if the build system attempts to build the recipe will be skipped, and if the build system attempts to build
the recipe then an error will be triggered. the recipe then an error will be triggered.
:term:`REQUIRED_VERSION`
If there are multiple versions of a recipe available, this variable
determines which version should be given preference.
:term:`REQUIRED_VERSION` works in exactly the same manner as
:term:`PREFERRED_VERSION`, except that if the specified version is not
available then an error message is shown and the build fails
immediately.
If both :term:`REQUIRED_VERSION` and :term:`PREFERRED_VERSION` are set
for the same recipe, the :term:`REQUIRED_VERSION` value applies.
:term:`RM_WORK_EXCLUDE` :term:`RM_WORK_EXCLUDE`
With ``rm_work`` enabled, this variable specifies a list of recipes With ``rm_work`` enabled, this variable specifies a list of recipes
whose work directories should not be removed. See the whose work directories should not be removed. See the