yoctoproject/poky-contrib
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky-contrib synced 2025-05-08 23:52:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual/variables.rst: improve the PKGV documentation

Browse Source 
It may be confusing for users that source control information is not
present in the BitBake environment. Document it as a warning block.

(From yocto-docs rev: 39967b9cc87cf216c4658598806fd7a68db5053a)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Antonin Godard 2025-03-25 12:13:04 +01:00 committed by Richard Purdie
parent 39cbc37918
commit 15a7d7b881
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7051,6 +7051,23 @@ system and gives an overview of their function and contents.
The version of the package(s) built by the recipe. By default,
:term:`PKGV` is set to :term:`PV`.
If :term:`PV` contains the ``+`` sign, source control information will be
included in :term:`PKGV` later in the packaging phase. For more
information, see the :doc:`/dev-manual/external-scm` section of the Yocto
Project Development Tasks Manual.
.. warning::
Since source control information is included in a late stage by the
:ref:`ref-classes-package` class, it cannot be seen from the BitBake
environment with ``bitbake -e`` or ``bitbake-getvar``. Instead, after
the package is built, the version information can be retrieved with
``oe-pkgdata-util package-info <package name>``. See the
:ref:`dev-manual/debugging:Viewing Package Information with
\`\`oe-pkgdata-util\`\`` section of the Yocto Project Development Tasks
Manual for more information on ``oe-pkgdata-util``.
:term:`PN`
This variable can have two separate functions depending on the
context: a recipe name or a resulting package name.