summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@microsoft.com>2021-04-12 16:19:55 +1200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-15 20:18:58 +0100
commit70441f2b7348ab5f877cdb24bcaf76c35fb69338 (patch)
treed75b7fa157aa6e64571d8542be1e188e1170fa7f /documentation/ref-manual/variables.rst
parent71b78ef384472c7714a582907acc166ed4b7e6b1 (diff)
downloadpoky-70441f2b7348ab5f877cdb24bcaf76c35fb69338.tar.gz
ref-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry
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>
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst24
1 files changed, 20 insertions, 4 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0574b78a1e..725600c0e5 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5798,10 +5798,11 @@ system and gives an overview of their function and contents.
5798 exclusive alternative providers. 5798 exclusive alternative providers.
5799 5799
5800 :term:`PREFERRED_VERSION` 5800 :term:`PREFERRED_VERSION`
5801 If multiple versions of recipes exist, this variable determines which 5801 If there are multiple versions of a recipe available, this variable
5802 version is given preference. You must always suffix the variable with 5802 determines which version should be given preference. You must always
5803 the :term:`PN` you want to select, and you should set the 5803 suffix the variable with the :term:`PN` you want to select (`python` in
5804 :term:`PV` accordingly for precedence. 5804 the first example below), and you should specify the :term:`PV`
5805 accordingly (`3.4.0` in the example).
5805 5806
5806 The ``PREFERRED_VERSION`` variable supports limited wildcard use 5807 The ``PREFERRED_VERSION`` variable supports limited wildcard use
5807 through the "``%``" character. You can use the character to match any 5808 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.
5859 The ``\_forcevariable`` override is not handled specially. This override 5860 The ``\_forcevariable`` override is not handled specially. This override
5860 only works because the default value of ``OVERRIDES`` includes "forcevariable". 5861 only works because the default value of ``OVERRIDES`` includes "forcevariable".
5861 5862
5863 If a recipe with the specified version is not available, a warning
5864 message will be shown. See :term:`REQUIRED_VERSION` if you want this
5865 to be an error instead.
5866
5862 :term:`PREMIRRORS` 5867 :term:`PREMIRRORS`
5863 Specifies additional paths from which the OpenEmbedded build system 5868 Specifies additional paths from which the OpenEmbedded build system
5864 gets source code. When the build system searches for source code, it 5869 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.
6216 the recipe will be skipped, and if the build system attempts to build 6221 the recipe will be skipped, and if the build system attempts to build
6217 the recipe then an error will be triggered. 6222 the recipe then an error will be triggered.
6218 6223
6224 :term:`REQUIRED_VERSION`
6225 If there are multiple versions of a recipe available, this variable
6226 determines which version should be given preference.
6227 :term:`REQUIRED_VERSION` works in exactly the same manner as
6228 :term:`PREFERRED_VERSION`, except that if the specified version is not
6229 available then an error message is shown and the build fails
6230 immediately.
6231
6232 If both :term:`REQUIRED_VERSION` and :term:`PREFERRED_VERSION` are set
6233 for the same recipe, the :term:`REQUIRED_VERSION` value applies.
6234
6219 :term:`RM_WORK_EXCLUDE` 6235 :term:`RM_WORK_EXCLUDE`
6220 With ``rm_work`` enabled, this variable specifies a list of recipes 6236 With ``rm_work`` enabled, this variable specifies a list of recipes
6221 whose work directories should not be removed. See the 6237 whose work directories should not be removed. See the