[PATCH] Doc: Updated auto sha256 syntax for sw-description

297 views
Skip to first unread message

Mathieu CHARLES

unread,
May 17, 2022, 10:05:46 AM5/17/22
to swup...@googlegroups.com, Mathieu CHARLES
Signed-off-by: Mathieu CHARLES <m8ch...@enib.fr>
---
doc/source/building-with-yocto.rst | 4 ++--
doc/source/swupdate-best-practise.rst | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/source/building-with-yocto.rst b/doc/source/building-with-yocto.rst
index e7abb95..49830de 100644
--- a/doc/source/building-with-yocto.rst
+++ b/doc/source/building-with-yocto.rst
@@ -153,13 +153,13 @@ is signed. Each artifact must have the attribute:

::

- sha256 = "@artifact-file-name"
+ sha256 = "$swupdate_get_sha256(artifact-file-name)"

For example, to add sha256 to the standard Yocto core-image-full-cmdline:

::

- sha256 = "@core-image-full-cmdline-machine.ubifs";
+ sha256 = "$swupdate_get_sha256(core-image-full-cmdline-machine.ubifs)";


The name of the file must be the same as in deploy directory.
diff --git a/doc/source/swupdate-best-practise.rst b/doc/source/swupdate-best-practise.rst
index b01d3c3..4c7cead 100644
--- a/doc/source/swupdate-best-practise.rst
+++ b/doc/source/swupdate-best-practise.rst
@@ -188,13 +188,13 @@ is :

::

- sha256 = "@<name of artifact>"
+ sha256 = "$swupdate_get_sha256(<name of artifact>)"

You can again use variable substitution for artifact names. Example:

::

- sha256 = "@@@SYSTEM_IMAGE@@-@@MACHINE@@@@SWUPDATE_IMAGES_FSTYPES[@@SYSTEM_IMAGE@@]@@";
+ sha256 = "$swupdate_get_sha256(@@SYSTEM_IMAGE@@-@@MACHINE@@@@SWUPDATE_IMAGES_FSTYPES[@@SYSTEM_IMAGE@@]@@)";

Please note that each variable is double delimited (at the beginning and at the end) by `@@`.

--
2.25.1

Reply all
Reply to author
Forward
0 new messages