summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorAatir Manzur <aatrapps@gmail.com>2022-06-28 14:31:43 -0400
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-06-30 17:09:51 +0100
commit9900bb5d13ff309fdf6ac28d211a50366a7288eb (patch)
tree85ed00333af0cc2096ca0eebb332d3b4ac2ef2ad /documentation
parentb10ba003c828856bd7778e73a9b8d9600891cae2 (diff)
downloadpoky-9900bb5d13ff309fdf6ac28d211a50366a7288eb.tar.gz
docs: add CONVERSION_CMD definition
(From yocto-docs rev: 05d376ccc65510a7d636e2685fb92a48d4712b0b) Signed-off-by: Aatir Manzur <aatrapps@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 fe7bc2cf55..16e48cc87c 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 c55c0b8c3c..bc2c75d42e 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 b42854caaa..c4b2119f26 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1297,6 +1297,19 @@ system and gives an overview of their function and contents.
1297 the recipe will be skipped, and if the build system attempts to build 1297 the recipe will be skipped, and if the build system attempts to build
1298 the recipe then an error will be triggered. 1298 the recipe then an error will be triggered.
1299 1299
1300 :term:`CONVERSION_CMD`
1301 This variable is used for storing image conversion commands.
1302 Image conversion can convert an image into different objects like:
1303
1304 - Compressed version of the image
1305
1306 - Checksums for the image
1307
1308 An example of :term:`CONVERSION_CMD` from :ref:`image-types
1309 <ref-classes-image_types>` class is::
1310
1311 CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
1312
1300 :term:`COPY_LIC_DIRS` 1313 :term:`COPY_LIC_DIRS`
1301 If set to "1" along with the 1314 If set to "1" along with the
1302 :term:`COPY_LIC_MANIFEST` variable, the 1315 :term:`COPY_LIC_MANIFEST` variable, the