[OE-core] [PATCH v4] image_types.bbclass: get rid of IMAGE_DEPENDS

[Richard Purdie]

On Fri, 2017-06-16 at 17:15 +0300, Ed Bartosh wrote:
> The IMAGE_DEPENDS_<type> variables can be set to add dependencies for
> individual image types.  Those dependencies are added to the
> do_rootfs
> task, while they really should be added to the specific image type
> tasks.
> 
> These variables are not documented anywhere.
> 
> Replaced usage of IMAGE_DEPENDS_<type> with explicitly added
> dependencies to do_image_<type> tasks.
> 
> [YOCTO #11302]
> 
> Signed-off-by: Ed Bartosh <ed.bartosh at linux.intel.com>
> ---
>  meta/classes/image_types.bbclass | 40 +++++++++++++++++++++---------
> ----------
>  1 file changed, 21 insertions(+), 19 deletions(-)
> 
> diff --git a/meta/classes/image_types.bbclass
> b/meta/classes/image_types.bbclass
> index 7749b00..ae6ac7a 100644
> --- a/meta/classes/image_types.bbclass
> +++ b/meta/classes/image_types.bbclass
> @@ -29,11 +29,8 @@ def imagetypes_getdepends(d):
>      deps = set()
>      for typestring in fstypes:
>          basetype, resttypes = split_types(typestring)
> -        adddep(d.getVar('IMAGE_DEPENDS_%s' % basetype) , deps)
> -
>          for typedepends in (d.getVar("IMAGE_TYPEDEP_%s" % basetype)
> or "").split():
>              base, rest = split_types(typedepends)
> -            adddep(d.getVar('IMAGE_DEPENDS_%s' % base) , deps)
>              resttypes += rest
>  
>          for ctype in resttypes:
> @@ -101,7 +98,7 @@ IMAGE_CMD_squashfs-lzo = "mksquashfs
> ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAM
>  # you need special parameters (like --xattrs) which are only
> supported
>  # by GNU tar upstream >= 1.27, then override that default:
>  # IMAGE_CMD_TAR = "tar --xattrs --xattrs-include=*"
> -# IMAGE_DEPENDS_tar_append = " tar-replacement-native"
> +# do_image_tar[depends] += "tar-replacement-
> native:do_populate_sysroot"
>  # EXTRANATIVEPATH += "tar-native"
>  #
>  # The GNU documentation does not specify whether --xattrs-include is
> necessary.
> @@ -209,21 +206,26 @@ EXTRA_IMAGECMD_ext4 ?= "-i 4096"
>  EXTRA_IMAGECMD_btrfs ?= "-n 4096"
>  EXTRA_IMAGECMD_elf ?= ""
>  
> -IMAGE_DEPENDS = ""
> -IMAGE_DEPENDS_jffs2 = "mtd-utils-native"
> -IMAGE_DEPENDS_cramfs = "util-linux-native"
> -IMAGE_DEPENDS_ext2 = "e2fsprogs-native"
> -IMAGE_DEPENDS_ext3 = "e2fsprogs-native"
> -IMAGE_DEPENDS_ext4 = "e2fsprogs-native"
> -IMAGE_DEPENDS_btrfs = "btrfs-tools-native"
> -IMAGE_DEPENDS_squashfs = "squashfs-tools-native"
> -IMAGE_DEPENDS_squashfs-xz = "squashfs-tools-native"
> -IMAGE_DEPENDS_squashfs-lzo = "squashfs-tools-native"
> -IMAGE_DEPENDS_elf = "virtual/kernel mkelfimage-native"
> -IMAGE_DEPENDS_ubi = "mtd-utils-native"
> -IMAGE_DEPENDS_ubifs = "mtd-utils-native"
> -IMAGE_DEPENDS_multiubi = "mtd-utils-native"
> -IMAGE_DEPENDS_wic = "parted-native"
> +python () {
> +    vars = [key for key in d if key.startswith('IMAGE_DEPENDS')]
> +    if vars:
> +        bb.fatal('Deprecated variable(s) found: "%s". '
> +                 'Use do_image_<type>[depends] += "<recipe>:<task>"
> instead' % ', '.join(vars))
> +}

I appreciate this looks like a good idea but iterating the data store
is about the worst thing we can do for parsing performance. Please just
put the error message into the other function. I suspect if you time
parsing before and after this change you could see this on a profile
graph although since it only affects image recipes, it might be harder
to spot within the noise, not sure.

Cheers,

Richard