summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/variables.rst59
1 files changed, 26 insertions, 33 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0c5c7aab97..2e57abe16c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -209,12 +209,11 @@ system and gives an overview of their function and contents.
209 SRCREV = "${AUTOREV}" 209 SRCREV = "${AUTOREV}"
210 210
211 If you use the previous statement to retrieve the latest version of 211 If you use the previous statement to retrieve the latest version of
212 software, you need to be sure :term:`PV` contains 212 software, you need to make sure :term:`PV` contains the ``+`` sign so
213 ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you have a kernel 213 :term:`bitbake` includes source control information to :term:`PKGV` when
214 recipe that inherits the :ref:`ref-classes-kernel` class and you 214 packaging the recipe. For example::
215 use the previous statement. In this example, ``${SRCPV}`` does not 215
216 automatically get into :term:`PV`. Consequently, you need to change 216 PV = "6.10.y+git"
217 :term:`PV` in your recipe so that it does contain ``${SRCPV}``.
218 217
219 For more information see the 218 For more information see the
220 ":ref:`dev-manual/packages:automatically incrementing a package version number`" 219 ":ref:`dev-manual/packages:automatically incrementing a package version number`"
@@ -5109,7 +5108,7 @@ system and gives an overview of their function and contents.
5109 The :term:`LINUX_VERSION` variable is used to define :term:`PV` 5108 The :term:`LINUX_VERSION` variable is used to define :term:`PV`
5110 for the recipe:: 5109 for the recipe::
5111 5110
5112 PV = "${LINUX_VERSION}+git${SRCPV}" 5111 PV = "${LINUX_VERSION}+git"
5113 5112
5114 :term:`LINUX_VERSION_EXTENSION` 5113 :term:`LINUX_VERSION_EXTENSION`
5115 A string extension compiled into the version string of the Linux 5114 A string extension compiled into the version string of the Linux
@@ -6657,22 +6656,14 @@ system and gives an overview of their function and contents.
6657 string. You cannot use the wildcard character in any other 6656 string. You cannot use the wildcard character in any other
6658 location of the string. 6657 location of the string.
6659 6658
6660 The specified version is matched against :term:`PV`, which 6659 The specified version is matched against :term:`PV`, which does not
6661 does not necessarily match the version part of the recipe's filename. 6660 necessarily match the version part of the recipe's filename.
6662 For example, consider two recipes ``foo_1.2.bb`` and ``foo_git.bb``
6663 where ``foo_git.bb`` contains the following assignment::
6664
6665 PV = "1.1+git${SRCPV}"
6666
6667 In this case, the correct way to select
6668 ``foo_git.bb`` is by using an assignment such as the following::
6669
6670 PREFERRED_VERSION_foo = "1.1+git%"
6671 6661
6672 Compare that previous example 6662 If you want to select a recipe named ``foo_git.bb`` which has :term:`PV`
6673 against the following incorrect example, which does not work:: 6663 set to ``1.2.3+git``, you can do so by setting ```PREFERRED_VERSION_foo``
6674 6664 to ``1.2.3%`` (i.e. simply setting ``PREFERRED_VERSION_foo`` to ``git``
6675 PREFERRED_VERSION_foo = "git" 6665 will not work as the name of the recipe isn't used, but rather its
6666 :term:`PV` definition).
6676 6667
6677 Sometimes the :term:`PREFERRED_VERSION` variable can be set by 6668 Sometimes the :term:`PREFERRED_VERSION` variable can be set by
6678 configuration files in a way that is hard to change. You can use 6669 configuration files in a way that is hard to change. You can use
@@ -8194,21 +8185,23 @@ system and gives an overview of their function and contents.
8194 (SCM). 8185 (SCM).
8195 8186
8196 :term:`SRCPV` 8187 :term:`SRCPV`
8197 Returns the version string of the current package. This string is 8188 The variable :term:`SRCPV` is deprecated. It was previously used to
8198 used to help define the value of :term:`PV`. 8189 include source control information in :term:`PV` for :term:`bitbake` to
8190 work correctly but this is no longer a requirement. Source control
8191 information will be automatically included by :term:`bitbake` in the
8192 variable :term:`PKGV` during packaging if the ``+`` sign is present in
8193 :term:`PV`.
8199 8194
8200 The :term:`SRCPV` variable is defined in the ``meta/conf/bitbake.conf`` 8195 .. note::
8201 configuration file in the :term:`Source Directory` as
8202 follows::
8203 8196
8204 SRCPV = "${@bb.fetch2.get_srcrev(d)}" 8197 The :term:`SRCPV` variable used to be defined in the
8198 ``meta/conf/bitbake.conf`` configuration file in the :term:`Source
8199 Directory` as follows::
8205 8200
8206 Recipes that need to define :term:`PV` do so with the help of the 8201 SRCPV = "${@bb.fetch2.get_srcrev(d)}"
8207 :term:`SRCPV`. For example, the ``ofono`` recipe (``ofono_git.bb``)
8208 located in ``meta/recipes-connectivity`` in the Source Directory
8209 defines :term:`PV` as follows::
8210 8202
8211 PV = "0.12-git${SRCPV}" 8203 The ``get_srcrev`` function can still be used to include source control
8204 information in variables manually.
8212 8205
8213 :term:`SRCREV` 8206 :term:`SRCREV`
8214 The revision of the source code used to build the package. This 8207 The revision of the source code used to build the package. This