diff options
author | Paul Eggleton <paul.eggleton@microsoft.com> | 2021-04-13 19:00:09 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-04-15 20:18:57 +0100 |
commit | f2a20f7bd08a0b6529e3505c0c66572bf9e6a665 (patch) | |
tree | f899f5474662a5e67f9d78a0945df40d56426137 /bitbake/doc | |
parent | 1892aae539dbd9544457e4dc8b76b20c631f65f7 (diff) | |
download | poky-f2a20f7bd08a0b6529e3505c0c66572bf9e6a665.tar.gz |
bitbake: bitbake-user-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.
(Bitbake rev: b32e6c8d4ea2f83fe77021207e9db883fec82d97)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 1528b04065..489fa15fad 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | |||
@@ -1096,8 +1096,8 @@ overview of their function and contents. | |||
1096 | PREFERRED_PROVIDER_aaa = "bbb" | 1096 | PREFERRED_PROVIDER_aaa = "bbb" |
1097 | 1097 | ||
1098 | :term:`PREFERRED_VERSION` | 1098 | :term:`PREFERRED_VERSION` |
1099 | If there are multiple versions of recipes available, this variable | 1099 | If there are multiple versions of a recipe available, this variable |
1100 | determines which recipe should be given preference. You must always | 1100 | determines which version should be given preference. You must always |
1101 | suffix the variable with the :term:`PN` you want to | 1101 | suffix the variable with the :term:`PN` you want to |
1102 | select, and you should set :term:`PV` accordingly for | 1102 | select, and you should set :term:`PV` accordingly for |
1103 | precedence. | 1103 | precedence. |
@@ -1117,6 +1117,10 @@ overview of their function and contents. | |||
1117 | end of the string. You cannot use the wildcard character in any other | 1117 | end of the string. You cannot use the wildcard character in any other |
1118 | location of the string. | 1118 | location of the string. |
1119 | 1119 | ||
1120 | If a recipe with the specified version is not available, a warning | ||
1121 | message will be shown. See :term:`REQUIRED_VERSION` if you want this | ||
1122 | to be an error instead. | ||
1123 | |||
1120 | :term:`PREMIRRORS` | 1124 | :term:`PREMIRRORS` |
1121 | Specifies additional paths from which BitBake gets source code. When | 1125 | Specifies additional paths from which BitBake gets source code. When |
1122 | the build system searches for source code, it first tries the local | 1126 | the build system searches for source code, it first tries the local |
@@ -1227,6 +1231,16 @@ overview of their function and contents. | |||
1227 | The directory in which a local copy of a ``google-repo`` directory is | 1231 | The directory in which a local copy of a ``google-repo`` directory is |
1228 | stored when it is synced. | 1232 | stored when it is synced. |
1229 | 1233 | ||
1234 | :term:`REQUIRED_VERSION` | ||
1235 | If there are multiple versions of a recipe available, this variable | ||
1236 | determines which version should be given preference. ``REQUIRED_VERSION`` | ||
1237 | works in exactly the same manner as :term:`PREFERRED_VERSION`, except | ||
1238 | that if the specified version is not available then an error message | ||
1239 | is shown and the build fails immediately. | ||
1240 | |||
1241 | If both ``REQUIRED_VERSION`` and ``PREFERRED_VERSION`` are set for | ||
1242 | the same recipe, the ``REQUIRED_VERSION`` value applies. | ||
1243 | |||
1230 | :term:`RPROVIDES` | 1244 | :term:`RPROVIDES` |
1231 | A list of package name aliases that a package also provides. These | 1245 | A list of package name aliases that a package also provides. These |
1232 | aliases are useful for satisfying runtime dependencies of other | 1246 | aliases are useful for satisfying runtime dependencies of other |