From 14186b29fb16527c00adbee3a6e9987f871a30f5 Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Wed, 9 Oct 2024 09:41:06 +0200 Subject: ref-manual: add missing image manifest variables New variables that control the output of the image task manifests. (From yocto-docs rev: e46af38733ae581c4aa180efc226d8a34ea4e590) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) (limited to 'documentation') diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 744c0bc11c..40771a51b1 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3797,6 +3797,25 @@ system and gives an overview of their function and contents. clear the value of this variable (set the value to ""). For example, this is typically cleared in :term:`Initramfs` image recipes. + :term:`IMAGE_OUTPUT_MANIFEST` + When inheriting the :ref:`ref-classes-image` class directly or through the + :ref:`ref-classes-core-image` class, the :term:`IMAGE_OUTPUT_MANIFEST` + points to a manifest ``json`` file that lists what images were created by + various image creation tasks (as defined by the :term:`IMAGE_FSTYPES` + variable). It is set in the :ref:`ref-classes-image` class as follows:: + + IMAGE_OUTPUT_MANIFEST = "${IMAGE_OUTPUT_MANIFEST_DIR}/manifest.json" + + :term:`IMAGE_OUTPUT_MANIFEST_DIR` + When inheriting the :ref:`ref-classes-image` class directly or through the + :ref:`ref-classes-core-image` class, the :term:`IMAGE_OUTPUT_MANIFEST_DIR` points to + a directory that stores a manifest ``json`` file that lists what + images were created by various image creation tasks (as defined by the + :term:`IMAGE_FSTYPES` variable). It is set in the :ref:`ref-classes-image` + class as follows:: + + IMAGE_OUTPUT_MANIFEST_DIR = "${WORKDIR}/deploy-image-output-manifest" + :term:`IMAGE_OVERHEAD_FACTOR` Defines a multiplier that the build system applies to the initial image size for cases when the multiplier times the returned disk @@ -4008,6 +4027,16 @@ system and gives an overview of their function and contents. files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. + :term:`IMGMANIFESTDIR` + When inheriting the :ref:`ref-classes-image` class directly or through the + :ref:`ref-classes-core-image` class, the :term:`IMGMANIFESTDIR` setting + points to a temporary area that stores manifest ``json`` files, that list + what images were created by various images creation tasks (as defined by + the :term:`IMAGE_FSTYPES` variable). It is set in the + :ref:`ref-classes-image` class as follows:: + + IMGMANIFESTDIR = "${WORKDIR}/image-task-manifest" + :term:`INCOMPATIBLE_LICENSE` Specifies a space-separated list of license names (as they would appear in :term:`LICENSE`) that should be excluded -- cgit v1.2.3-54-g00ecf