diff mbox series

Doc: Update building with Yocto

Message ID 20210928182558.14336-1-colin.mcallister@garmin.com
State Accepted
Headers show
Series Doc: Update building with Yocto | expand

Commit Message

McAllister, Colin Sept. 28, 2021, 6:25 p.m. UTC
Updated Yocto-related documentation to add information about using the
hash of an image as the version.

Change-Id: Ib43baeeab35a1f679176c9f1ad3b876a14dbf3eb
Signed-off-by: Colin McAllister <colin.mcallister@garmin.com>
---
 doc/source/building-with-yocto.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

Comments

Stefano Babic Sept. 30, 2021, 7:20 a.m. UTC | #1
On 28.09.21 20:25, 'Colin McAllister' via swupdate wrote:
> Updated Yocto-related documentation to add information about using the
> hash of an image as the version.
> 
> Change-Id: Ib43baeeab35a1f679176c9f1ad3b876a14dbf3eb
> Signed-off-by: Colin McAllister <colin.mcallister@garmin.com>
> ---
>   doc/source/building-with-yocto.rst | 18 ++++++++++++++++++
>   1 file changed, 18 insertions(+)
> 
> diff --git a/doc/source/building-with-yocto.rst b/doc/source/building-with-yocto.rst
> index 42a379c..7085bfb 100644
> --- a/doc/source/building-with-yocto.rst
> +++ b/doc/source/building-with-yocto.rst
> @@ -218,6 +218,24 @@ Or combined with a different package name:
>           ...
>           version = "@SWU_AUTO_VERSION:u-boot@PKGV";
>   
> +Using checksum for version
> +--------------------------
> +
> +It is possible to use the hash of an artifact as the version in order to use
> +"install-if-different".  This allows versionless artifacts to be skipped if the
> +artifact in the update matches the currently installed artifact.
> +
> +In order to use the hash as the version, the sha256 hash file placeholder
> +described above in Automatic sha256 in sw-description must be used for version.
> +
> +Each artifact must have the attribute:
> +
> +::
> +
> +        version = "@artifact-file-name"
> +
> +The name of the file must be the same as in deploy directory.
> +
>   Template for recipe using the class
>   -----------------------------------
>   
> 

Applied to -master, thanks !

Best regards,
Stefano Babic
diff mbox series

Patch

diff --git a/doc/source/building-with-yocto.rst b/doc/source/building-with-yocto.rst
index 42a379c..7085bfb 100644
--- a/doc/source/building-with-yocto.rst
+++ b/doc/source/building-with-yocto.rst
@@ -218,6 +218,24 @@  Or combined with a different package name:
         ...
         version = "@SWU_AUTO_VERSION:u-boot@PKGV";
 
+Using checksum for version
+--------------------------
+
+It is possible to use the hash of an artifact as the version in order to use
+"install-if-different".  This allows versionless artifacts to be skipped if the
+artifact in the update matches the currently installed artifact.
+
+In order to use the hash as the version, the sha256 hash file placeholder
+described above in Automatic sha256 in sw-description must be used for version.
+
+Each artifact must have the attribute:
+
+::
+
+        version = "@artifact-file-name"
+
+The name of the file must be the same as in deploy directory.
+
 Template for recipe using the class
 -----------------------------------