summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@microsoft.com>2020-10-27 18:18:33 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-10-30 12:09:21 +0000
commiteac7b4bc3ef7208c23145b613cc049265ea28d07 (patch)
treed1241c166d5a83de181a5163c762673020d4995b /documentation/ref-manual
parent5f2e106d61b3f379af681b8fe8007f8e16790efc (diff)
downloadpoky-eac7b4bc3ef7208c23145b613cc049265ea28d07.tar.gz
ref-manual: add IMAGE_VERSION_SUFFIX variable
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>
Diffstat (limited to 'documentation/ref-manual')
-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 1ab3146cf9..e26e5531d2 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -3121,11 +3121,11 @@ system and gives an overview of their function and contents.
3121 :term:`IMAGE_NAME` 3121 :term:`IMAGE_NAME`
3122 The name of the output image files minus the extension. This variable 3122 The name of the output image files minus the extension. This variable
3123 is derived using the :term:`IMAGE_BASENAME`, 3123 is derived using the :term:`IMAGE_BASENAME`,
3124 :term:`MACHINE`, and :term:`DATETIME` 3124 :term:`MACHINE`, and :term:`IMAGE_VERSION_SUFFIX`
3125 variables: 3125 variables:
3126 :: 3126 ::
3127 3127
3128 IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" 3128 IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3129 3129
3130 :term:`IMAGE_OVERHEAD_FACTOR` 3130 :term:`IMAGE_OVERHEAD_FACTOR`
3131 Defines a multiplier that the build system applies to the initial 3131 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.
3329 For more information about these types of images, see 3329 For more information about these types of images, see
3330 ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`. 3330 ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`.
3331 3331
3332 :term:`IMAGE_VERSION_SUFFIX`
3333 Version suffix that is part of the default :term:`IMAGE_NAME` and
3334 :term:`KERNEL_ARTIFACT_NAME` values.
3335 Defaults to ``"-${DATETIME}"``, however you could set this to a
3336 version string that comes from your external build environment if
3337 desired, and this suffix would then be used consistently across
3338 the build artifacts.
3339
3332 :term:`INC_PR` 3340 :term:`INC_PR`
3333 Helps define the recipe revision for recipes that share a common 3341 Helps define the recipe revision for recipes that share a common
3334 ``include`` file. You can think of this variable as part of the 3342 ``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.
3787 3795
3788 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 3796 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3789 3797
3790 See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, and :term:`MACHINE` 3798 See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, :term:`MACHINE`
3791 variables for additional information. 3799 and :term:`IMAGE_VERSION_SUFFIX` variables for additional information.
3792
3793 .. note::
3794
3795 The ``IMAGE_VERSION_SUFFIX`` variable is set to :term:`DATETIME`.
3796 3800
3797 :term:`KERNEL_CLASSES` 3801 :term:`KERNEL_CLASSES`
3798 A list of classes defining kernel image types that the 3802 A list of classes defining kernel image types that the