[2/3] ref-manual: add migration info for image-artifact-names

Submitted by Paul Eggleton on Oct. 28, 2020, 11:36 a.m. | Patch ID: 177620

Details

Message ID 56868b37a748a7e391631b56cc655f15bc46a5d7.1603884913.git.paul.eggleton@linux.microsoft.com
State New
Headers show

Commit Message

Paul Eggleton Oct. 28, 2020, 11:36 a.m.
From: Paul Eggleton <paul.eggleton@microsoft.com>

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

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
 documentation/ref-manual/migration-3.2.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

Patch hide | download patch | download mbox

diff --git a/documentation/ref-manual/migration-3.2.rst b/documentation/ref-manual/migration-3.2.rst
index a56c5d4..3c0ea7b 100644
--- a/documentation/ref-manual/migration-3.2.rst
+++ b/documentation/ref-manual/migration-3.2.rst
@@ -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