From eac7b4bc3ef7208c23145b613cc049265ea28d07 Mon Sep 17 00:00:00 2001 From: Paul Eggleton Date: Tue, 27 Oct 2020 18:18:33 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-variables.rst | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) (limited to 'documentation/ref-manual') 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. :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 -- cgit v1.2.3-54-g00ecf