summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-10-09 09:41:06 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-10-11 17:04:54 +0100
commit14186b29fb16527c00adbee3a6e9987f871a30f5 (patch)
treefd07c039b44fff8b829ab3cecbb4af58ec99a4ac /documentation
parent3cf1818e08951a0c83e1fedf942ab7dd22bd57bb (diff)
downloadpoky-14186b29fb16527c00adbee3a6e9987f871a30f5.tar.gz
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 <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/variables.rst29
1 files changed, 29 insertions, 0 deletions
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.
3797 clear the value of this variable (set the value to ""). For example, 3797 clear the value of this variable (set the value to ""). For example,
3798 this is typically cleared in :term:`Initramfs` image recipes. 3798 this is typically cleared in :term:`Initramfs` image recipes.
3799 3799
3800 :term:`IMAGE_OUTPUT_MANIFEST`
3801 When inheriting the :ref:`ref-classes-image` class directly or through the
3802 :ref:`ref-classes-core-image` class, the :term:`IMAGE_OUTPUT_MANIFEST`
3803 points to a manifest ``json`` file that lists what images were created by
3804 various image creation tasks (as defined by the :term:`IMAGE_FSTYPES`
3805 variable). It is set in the :ref:`ref-classes-image` class as follows::
3806
3807 IMAGE_OUTPUT_MANIFEST = "${IMAGE_OUTPUT_MANIFEST_DIR}/manifest.json"
3808
3809 :term:`IMAGE_OUTPUT_MANIFEST_DIR`
3810 When inheriting the :ref:`ref-classes-image` class directly or through the
3811 :ref:`ref-classes-core-image` class, the :term:`IMAGE_OUTPUT_MANIFEST_DIR` points to
3812 a directory that stores a manifest ``json`` file that lists what
3813 images were created by various image creation tasks (as defined by the
3814 :term:`IMAGE_FSTYPES` variable). It is set in the :ref:`ref-classes-image`
3815 class as follows::
3816
3817 IMAGE_OUTPUT_MANIFEST_DIR = "${WORKDIR}/deploy-image-output-manifest"
3818
3800 :term:`IMAGE_OVERHEAD_FACTOR` 3819 :term:`IMAGE_OVERHEAD_FACTOR`
3801 Defines a multiplier that the build system applies to the initial 3820 Defines a multiplier that the build system applies to the initial
3802 image size for cases when the multiplier times the returned disk 3821 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.
4008 files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take 4027 files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take
4009 care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. 4028 care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards.
4010 4029
4030 :term:`IMGMANIFESTDIR`
4031 When inheriting the :ref:`ref-classes-image` class directly or through the
4032 :ref:`ref-classes-core-image` class, the :term:`IMGMANIFESTDIR` setting
4033 points to a temporary area that stores manifest ``json`` files, that list
4034 what images were created by various images creation tasks (as defined by
4035 the :term:`IMAGE_FSTYPES` variable). It is set in the
4036 :ref:`ref-classes-image` class as follows::
4037
4038 IMGMANIFESTDIR = "${WORKDIR}/image-task-manifest"
4039
4011 :term:`INCOMPATIBLE_LICENSE` 4040 :term:`INCOMPATIBLE_LICENSE`
4012 Specifies a space-separated list of license names (as they would 4041 Specifies a space-separated list of license names (as they would
4013 appear in :term:`LICENSE`) that should be excluded 4042 appear in :term:`LICENSE`) that should be excluded