From bec73cd4e6322d749e4b866138045ce05817c611 Mon Sep 17 00:00:00 2001 From: Daniel Wagenknecht Date: Fri, 11 Jun 2021 09:30:46 +0200 Subject: ref-manual: migration-2.2: add note about IMGDEPLOYDIR (From yocto-docs rev: e9921b746a0b2a4a2192bab224d9afa9d9395e1e) Signed-off-by: Daniel Wagenknecht Reviewed-by: Michael Opdenacker Reviewed-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/migration-guides/migration-2.2.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'documentation') diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index 76311107ec..e30761dc99 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst @@ -263,6 +263,17 @@ If you have recipes or classes that use ``KERNEL_IMAGE_BASE_NAME`` directly, you might need to update the references to ensure they continue to work. +.. _migration-2.2-imgdeploydir-replaces-deploy-dir-image-for-most-use-cases: + +``IMGDEPLOYDIR`` Replaces ``DEPLOY_DIR_IMAGE`` for Most Use Cases +----------------------------------------------------------------- + +The :term:`IMGDEPLOYDIR` variable was introduced to allow sstate caching of +image creation results. Image recipes defining custom :term:`IMAGE_CMD` or +doing postprocessing on the generated images need to be adapted to use +``IMGDEPLOYDIR`` instead of :term:`DEPLOY_DIR_IMAGE`. ``IMAGE_MANIFEST`` +creation and symlinking of the most recent image file will fail otherwise. + .. _migration-2.2-bitbake-changes: BitBake Changes -- cgit v1.2.3-54-g00ecf