summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-variables.rst')
-rw-r--r--documentation/ref-manual/ref-variables.rst20
1 files changed, 12 insertions, 8 deletions
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 3755f80a44..d0850c3c47 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -3062,11 +3062,11 @@ system and gives an overview of their function and contents.
3062 :term:`IMAGE_NAME` 3062 :term:`IMAGE_NAME`
3063 The name of the output image files minus the extension. This variable 3063 The name of the output image files minus the extension. This variable
3064 is derived using the :term:`IMAGE_BASENAME`, 3064 is derived using the :term:`IMAGE_BASENAME`,
3065 :term:`MACHINE`, and :term:`DATETIME` 3065 :term:`MACHINE`, and :term:`IMAGE_VERSION_SUFFIX`
3066 variables: 3066 variables:
3067 :: 3067 ::
3068 3068
3069 IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" 3069 IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3070 3070
3071 :term:`IMAGE_OVERHEAD_FACTOR` 3071 :term:`IMAGE_OVERHEAD_FACTOR`
3072 Defines a multiplier that the build system applies to the initial 3072 Defines a multiplier that the build system applies to the initial
@@ -3270,6 +3270,14 @@ system and gives an overview of their function and contents.
3270 For more information about these types of images, see 3270 For more information about these types of images, see
3271 ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`. 3271 ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`.
3272 3272
3273 :term:`IMAGE_VERSION_SUFFIX`
3274 Version suffix that is part of the default :term:`IMAGE_NAME` and
3275 :term:`KERNEL_ARTIFACT_NAME` values.
3276 Defaults to ``"-${DATETIME}"``, however you could set this to a
3277 version string that comes from your external build environment if
3278 desired, and this suffix would then be used consistently across
3279 the build artifacts.
3280
3273 :term:`INC_PR` 3281 :term:`INC_PR`
3274 Helps define the recipe revision for recipes that share a common 3282 Helps define the recipe revision for recipes that share a common
3275 ``include`` file. You can think of this variable as part of the 3283 ``include`` file. You can think of this variable as part of the
@@ -3728,12 +3736,8 @@ system and gives an overview of their function and contents.
3728 3736
3729 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 3737 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3730 3738
3731 See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, and :term:`MACHINE` 3739 See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, :term:`MACHINE`
3732 variables for additional information. 3740 and :term:`IMAGE_VERSION_SUFFIX` variables for additional information.
3733
3734 .. note::
3735
3736 The ``IMAGE_VERSION_SUFFIX`` variable is set to :term:`DATETIME`.
3737 3741
3738 :term:`KERNEL_CLASSES` 3742 :term:`KERNEL_CLASSES`
3739 A list of classes defining kernel image types that the 3743 A list of classes defining kernel image types that the