summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@microsoft.com>2021-04-12 23:37:21 +1200
committerPaul Eggleton <paul.eggleton@microsoft.com>2021-04-12 23:38:32 +1200
commitc4377cdd3c36293bedaaf4fb0e0ee02c56a800a0 (patch)
tree312a1887afabb6cb506fbf592202e15839240e63
parente18c6851ed98b4cac6b0eda0636a2e6eae88eb09 (diff)
downloadbitbake-contrib-paule/doc-git-pw.tar.gz
bitbake-contrib-paule/doc-git-pw.tar.bz2
bitbake-contrib-paule/doc-git-pw.zip
bitbake-user-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entrypaule/doc-git-pw
Add REQUIRED_VERSION, add a reference to it in PREFERRED_VERSION and adjust the opening statement to read slightly better. Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst18
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 1528b04065..489fa15fad 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1096,8 +1096,8 @@ overview of their function and contents.
PREFERRED_PROVIDER_aaa = "bbb"
:term:`PREFERRED_VERSION`
- If there are multiple versions of recipes available, this variable
- determines which recipe should be given preference. You must always
+ If there are multiple versions of a recipe available, this variable
+ determines which version should be given preference. You must always
suffix the variable with the :term:`PN` you want to
select, and you should set :term:`PV` accordingly for
precedence.
@@ -1117,6 +1117,10 @@ overview of their function and contents.
end of the string. You cannot use the wildcard character in any other
location of the string.
+ 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`
Specifies additional paths from which BitBake gets source code. When
the build system searches for source code, it first tries the local
@@ -1227,6 +1231,16 @@ overview of their function and contents.
The directory in which a local copy of a ``google-repo`` directory is
stored when it is synced.
+ :term:`REQUIRED_VERSION`
+ If there are multiple versions of a recipe available, this variable
+ determines which version should be given preference. ``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 ``REQUIRED_VERSION`` and ``PREFERRED_VERSION`` are set for
+ the same recipe, the ``REQUIRED_VERSION`` value applies.
+
:term:`RPROVIDES`
A list of package name aliases that a package also provides. These
aliases are useful for satisfying runtime dependencies of other