Re: [OE-core] [PATCH 09/14] image-artifact-names: add IMAGE_MACHINE_SUFFIX variable

Paul Eggleton
2023-04-18T22:43:16Z

Hi Martin

On Tuesday, 14 March 2023 01:15:36 NZST Martin Jansa wrote:
> * to make it easier for projects to avoid default -${MACHINE} suffix if
> the ${MACHINE} named DEPLOY_DIR_IMAGE works better for them
>
> * also use IMAGE_LINK_NAME in IMAGE_NAME to make it more clear
> that IMAGE_NAME is the same as IMAGE_LINK_NAME but with version
> suffix
>
> * adding it as separate variable helps us to catch the cases
> where we didn't respect ${IMAGE_LINK_NAME} variable and just used
> the common default ${IMAGE_BASENAME}-${MACHINE}.
>
> [YOCTO #12937]
>
> Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
> ---
> meta/classes-recipe/image-artifact-names.bbclass | 15 ++++++++++++---
> meta/classes-recipe/kernel-artifact-names.bbclass | 2 +-
> 2 files changed, 13 insertions(+), 4 deletions(-)
>
> diff --git a/meta/classes-recipe/image-artifact-names.bbclass
> b/meta/classes-recipe/image-artifact-names.bbclass index
> 9dc25b6dde..ac2376d59a 100644
> --- a/meta/classes-recipe/image-artifact-names.bbclass
> +++ b/meta/classes-recipe/image-artifact-names.bbclass
> @@ -11,11 +11,20 @@
> IMAGE_BASENAME ?= "${PN}"
> IMAGE_VERSION_SUFFIX ?= "-${DATETIME}"
> IMAGE_VERSION_SUFFIX[vardepsexclude] += "DATETIME SOURCE_DATE_EPOCH"
> -IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
> -IMAGE_LINK_NAME ?= "${IMAGE_BASENAME}-${MACHINE}"
> +IMAGE_NAME ?= "${IMAGE_LINK_NAME}${IMAGE_VERSION_SUFFIX}"
> +IMAGE_LINK_NAME ?= "${IMAGE_BASENAME}${IMAGE_MACHINE_SUFFIX}"

So there's a minor unfortunate side-effect of this in that you can no longer
just set IMAGE_LINK_NAME = "" to drop the symlinks - a minority use case, but
something I have used. Of course you can just re-set the value of IMAGE_NAME.
I am making a note in the manual and migration guide.

Cheers
Paul