ref-manual: add migration info for image-artifact-names

Add some info on the image-artifact-names class change in gatesgarth.

(From yocto-docs rev: 71dd9d92bf58c73f5fb3bd14cf8031bfc794fd3f)

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton authored and Richard Purdie committed 2020-10-30 12:09:21 +00:00
1 parent 778ef21609
commit 4f91a3339c
1 file changed
+21
@@ -246,6 +246,27 @@ by these image recipes directly then you will need to adapt to the new
naming without the ``.rootfs`` part.
.. _migration-3.2-image-artifact-names:
Image artifact name variables now centralised in image-artifact-names class
---------------------------------------------------------------------------
The defaults for the following image artifact name variables have been moved
from bitbake.conf to a new ``image-artifact-names`` class:
- :term:`IMAGE_BASENAME`
- :term:`IMAGE_LINK_NAME`
- :term:`IMAGE_NAME`
- :term:`IMAGE_NAME_SUFFIX`
- :term:`IMAGE_VERSION_SUFFIX`
Image-related classes now inherit this class, and typically these variables
are only referenced within image recipes so those will be unaffected by this
change. However if you have references to these variables in either a recipe
that is not an image or a class that is enabled globally, then those will
now need to be changed to ``inherit image-artifact-names``.
.. _migration-3.2-misc:
Miscellaneous changes