summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorAatir Manzur <aatrapps@gmail.com>2022-06-28 14:31:43 -0400
committerSteve Sakoman <steve@sakoman.com>2023-12-21 06:14:00 -1000
commit064936af55819541a9653928389a62a1a9b7c9f1 (patch)
tree89cd779b027edd055ded3ed8b1fade3010b497cf /documentation
parent3a5ddec4d1ea6aabdf3894e29e45126778795ea2 (diff)
downloadpoky-064936af55819541a9653928389a62a1a9b7c9f1.tar.gz
docs: add CONVERSION_CMD definition
(From yocto-docs rev: ba1458b04e2828e728c2815b1221e9399132d25d) Signed-off-by: Aatir Manzur <aatrapps@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/migration-guides/migration-2.2.rst2
-rw-r--r--documentation/migration-guides/migration-2.4.rst2
-rw-r--r--documentation/migration-guides/migration-3.4.rst2
-rw-r--r--documentation/ref-manual/variables.rst13
4 files changed, 16 insertions, 3 deletions
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst
index 10aa2d0684..3803dea832 100644
--- a/documentation/migration-guides/migration-2.2.rst
+++ b/documentation/migration-guides/migration-2.2.rst
@@ -442,7 +442,7 @@ The following miscellaneous changes have occurred:
442- :ref:`ref-classes-image`: Renamed COMPRESS(ION) to CONVERSION. This change 442- :ref:`ref-classes-image`: Renamed COMPRESS(ION) to CONVERSION. This change
443 means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and 443 means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and
444 ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``, 444 ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``,
445 ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*`` 445 ``CONVERSION_DEPENDS`` and :term:`CONVERSION_CMD`. The ``COMPRESS*``
446 variable names will still work in the 2.2 release but metadata that 446 variable names will still work in the 2.2 release but metadata that
447 does not need to be backwards-compatible should be changed to use the 447 does not need to be backwards-compatible should be changed to use the
448 new names as the ``COMPRESS*`` ones will be removed in a future 448 new names as the ``COMPRESS*`` ones will be removed in a future
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst
index ef5f32e6ef..964ed92937 100644
--- a/documentation/migration-guides/migration-2.4.rst
+++ b/documentation/migration-guides/migration-2.4.rst
@@ -301,7 +301,7 @@ The following are additional changes:
301 likely be removed in the next Yocto Project release. 301 likely be removed in the next Yocto Project release.
302 302
303- The ``vmdk``, ``vdi``, and ``qcow2`` image file types are now used in 303- The ``vmdk``, ``vdi``, and ``qcow2`` image file types are now used in
304 conjunction with the "wic" image type through ``CONVERSION_CMD``. 304 conjunction with the "wic" image type through :term:`CONVERSION_CMD`.
305 Consequently, the equivalent image types are now ``wic.vmdk``, 305 Consequently, the equivalent image types are now ``wic.vmdk``,
306 ``wic.vdi``, and ``wic.qcow2``, respectively. 306 ``wic.vdi``, and ``wic.qcow2``, respectively.
307 307
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst
index d57c955eb4..5fc2ef78fe 100644
--- a/documentation/migration-guides/migration-3.4.rst
+++ b/documentation/migration-guides/migration-3.4.rst
@@ -252,7 +252,7 @@ Miscellaneous
252 252
253- The previously deprecated ``COMPRESS_CMD`` and 253- The previously deprecated ``COMPRESS_CMD`` and
254 ``CVE_CHECK_CVE_WHITELIST`` variables have been removed. Use 254 ``CVE_CHECK_CVE_WHITELIST`` variables have been removed. Use
255 ``CONVERSION_CMD`` and ``CVE_CHECK_WHITELIST`` (replaced by 255 :term:`CONVERSION_CMD` and ``CVE_CHECK_WHITELIST`` (replaced by
256 :term:`CVE_CHECK_IGNORE` in version 3.5) respectively 256 :term:`CVE_CHECK_IGNORE` in version 3.5) respectively
257 instead. 257 instead.
258 258
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0a0b0ad37a..fe0b993bd8 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1342,6 +1342,19 @@ system and gives an overview of their function and contents.
1342 the recipe will be skipped, and if the build system attempts to build 1342 the recipe will be skipped, and if the build system attempts to build
1343 the recipe then an error will be triggered. 1343 the recipe then an error will be triggered.
1344 1344
1345 :term:`CONVERSION_CMD`
1346 This variable is used for storing image conversion commands.
1347 Image conversion can convert an image into different objects like:
1348
1349 - Compressed version of the image
1350
1351 - Checksums for the image
1352
1353 An example of :term:`CONVERSION_CMD` from :ref:`image-types
1354 <ref-classes-image_types>` class is::
1355
1356 CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
1357
1345 :term:`COPY_LIC_DIRS` 1358 :term:`COPY_LIC_DIRS`
1346 If set to "1" along with the 1359 If set to "1" along with the
1347 :term:`COPY_LIC_MANIFEST` variable, the 1360 :term:`COPY_LIC_MANIFEST` variable, the