Message ID | 20210927183657.10640-1-colin.mcallister@garmin.com |
---|---|
State | Changes Requested |
Headers | show |
Series | Doc: Update building with Yocto | expand |
Hi Colin, On 27.09.21 20:36, '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 | 4 ++++ > 1 file changed, 4 insertions(+) > > diff --git a/doc/source/building-with-yocto.rst b/doc/source/building-with-yocto.rst > index 42a379c..f357a69 100644 > --- a/doc/source/building-with-yocto.rst > +++ b/doc/source/building-with-yocto.rst > @@ -162,6 +162,10 @@ For example, to add sha256 to the standard Yocto core-image-full-cmdline: > > The name of the file must be the same as in deploy directory. > > +Additionally, the sha256 hash placeholder can be used in place of the version. > +This allows for an image to be installed only if the current image's hash does > +not match the hash of the image contained within the update. > + > BitBake variable expansion in sw-description > -------------------------------------------- > > This is quite too short description. Because the decision was to put most documentation in the SWUpdate repo instead of meta-swupdate to get everything in one place, this is the right place to do, also with the notes you put in README for meta-swupdate. The place is also wrong because you are using sha256 as version, and this should be described as a way to set version. So as " Automatic versions in sw-description", I am expecting something like "Using sha256 as version", or something like that. And an example should be provided with version = "@filename"; Best regards, Stefano Babic
diff --git a/doc/source/building-with-yocto.rst b/doc/source/building-with-yocto.rst index 42a379c..f357a69 100644 --- a/doc/source/building-with-yocto.rst +++ b/doc/source/building-with-yocto.rst @@ -162,6 +162,10 @@ For example, to add sha256 to the standard Yocto core-image-full-cmdline: The name of the file must be the same as in deploy directory. +Additionally, the sha256 hash placeholder can be used in place of the version. +This allows for an image to be installed only if the current image's hash does +not match the hash of the image contained within the update. + BitBake variable expansion in sw-description --------------------------------------------
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 | 4 ++++ 1 file changed, 4 insertions(+)