From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>,
Aatir Manzur <aatrapps@gmail.com>
Subject: [kirkstone][PATCH 07/18] docs: add CONVERSION_CMD definition
Date: Mon, 18 Dec 2023 22:44:31 +0100 [thread overview]
Message-ID: <20231218214442.147385-8-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com>
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
From: Aatir Manzur <aatrapps@gmail.com>
Signed-off-by: Aatir Manzur <aatrapps@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/migration-guides/migration-2.2.rst | 2 +-
documentation/migration-guides/migration-2.4.rst | 2 +-
documentation/migration-guides/migration-3.4.rst | 2 +-
documentation/ref-manual/variables.rst | 13 +++++++++++++
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:
- :ref:`ref-classes-image`: Renamed COMPRESS(ION) to CONVERSION. This change
means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and
``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``,
- ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*``
+ ``CONVERSION_DEPENDS`` and :term:`CONVERSION_CMD`. The ``COMPRESS*``
variable names will still work in the 2.2 release but metadata that
does not need to be backwards-compatible should be changed to use the
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:
likely be removed in the next Yocto Project release.
- The ``vmdk``, ``vdi``, and ``qcow2`` image file types are now used in
- conjunction with the "wic" image type through ``CONVERSION_CMD``.
+ conjunction with the "wic" image type through :term:`CONVERSION_CMD`.
Consequently, the equivalent image types are now ``wic.vmdk``,
``wic.vdi``, and ``wic.qcow2``, respectively.
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
- The previously deprecated ``COMPRESS_CMD`` and
``CVE_CHECK_CVE_WHITELIST`` variables have been removed. Use
- ``CONVERSION_CMD`` and ``CVE_CHECK_WHITELIST`` (replaced by
+ :term:`CONVERSION_CMD` and ``CVE_CHECK_WHITELIST`` (replaced by
:term:`CVE_CHECK_IGNORE` in version 3.5) respectively
instead.
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.
the recipe will be skipped, and if the build system attempts to build
the recipe then an error will be triggered.
+ :term:`CONVERSION_CMD`
+ This variable is used for storing image conversion commands.
+ Image conversion can convert an image into different objects like:
+
+ - Compressed version of the image
+
+ - Checksums for the image
+
+ An example of :term:`CONVERSION_CMD` from :ref:`image-types
+ <ref-classes-image_types>` class is::
+
+ CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
+
:term:`COPY_LIC_DIRS`
If set to "1" along with the
:term:`COPY_LIC_MANIFEST` variable, the
--
2.34.1
next prev parent reply other threads:[~2023-12-18 21:45 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-18 21:44 [kirkstone][PATCH 00/18] Documentation backports michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 01/18] ref-manual: Fix reference to MIRRORS/PREMIRRORS defaults michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 02/18] manuals: fix URL michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 03/18] ref-manual: releases.svg: update nanbield release status michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 04/18] dev-manual: layers: update link to YP Compatible form michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 05/18] contributor-guide: add License-Update tag michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 06/18] contributor-guide: fix command option michael.opdenacker
2023-12-18 21:44 ` michael.opdenacker [this message]
2023-12-18 21:44 ` [kirkstone][PATCH 08/18] migration-guides: release 3.5 is actually 4.0 michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 09/18] dev-manual: Discourage the use of SRC_URI[md5sum] michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 10/18] test-manual: text and formatting fixes michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 11/18] test-manual: resource updates michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 12/18] test-manual: add links to python unittest michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 13/18] test-manual: explicit or fix file paths michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 14/18] test-manual: add or improve hyperlinks michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 15/18] manuals: brief-yoctoprojectqs: align variable order with default local.conf michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 16/18] dev-manual: runtime-testing: fix test module name michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 17/18] migration-guides: add release notes for 4.0.15 michael.opdenacker
2023-12-18 21:44 ` [kirkstone][PATCH 18/18] test-manual: use working example michael.opdenacker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231218214442.147385-8-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=aatrapps@gmail.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox