CaROS/poky
3
1
Fork 0
mirror of https://git.yoctoproject.org/git/poky synced 2026-01-01 13:58:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: add IMAGE_VERSION_SUFFIX variable

Browse Source 
Add an entry to the variable glossary for IMAGE_VERSION_SUFFIX (which
was added in thud) and update the IMAGE_NAME and KERNEL_ARTIFACT_NAME
entries whose defaults use this variable.

(From yocto-docs rev: 1a02c4be8e348687d4f7e09aefc408aaed5f1be5)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton 2020-10-27 18:18:33 -07:00 committed by Richard Purdie
parent 5f2e106d61
commit eac7b4bc3e
1 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3121,11 +3121,11 @@ system and gives an overview of their function and contents.
:term:`IMAGE_NAME`
The name of the output image files minus the extension. This variable
is derived using the :term:`IMAGE_BASENAME`,
:term:`MACHINE`, and :term:`DATETIME`
:term:`MACHINE`, and :term:`IMAGE_VERSION_SUFFIX`
variables:
::
IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}"
IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
:term:`IMAGE_OVERHEAD_FACTOR`
Defines a multiplier that the build system applies to the initial
@ -3329,6 +3329,14 @@ system and gives an overview of their function and contents.
For more information about these types of images, see
``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`.
:term:`IMAGE_VERSION_SUFFIX`
Version suffix that is part of the default :term:`IMAGE_NAME` and
:term:`KERNEL_ARTIFACT_NAME` values.
Defaults to ``"-${DATETIME}"``, however you could set this to a
version string that comes from your external build environment if
desired, and this suffix would then be used consistently across
the build artifacts.
:term:`INC_PR`
Helps define the recipe revision for recipes that share a common
``include`` file. You can think of this variable as part of the
@ -3787,12 +3795,8 @@ system and gives an overview of their function and contents.
KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, and :term:`MACHINE`
variables for additional information.
.. note::
The ``IMAGE_VERSION_SUFFIX`` variable is set to :term:`DATETIME`.
See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, :term:`MACHINE`
and :term:`IMAGE_VERSION_SUFFIX` variables for additional information.
:term:`KERNEL_CLASSES`
A list of classes defining kernel image types that the