Clean up "Writing consistent snapshots" section

theupdateframework / specification

The Update Framework specification

https://theupdateframework.github.io/specification/

Other

368 stars 54 forks source link

Clean up "Writing consistent snapshots" section #187

Closed joshuagl closed 2 years ago

joshuagl commented 2 years ago

Match how metadata and target filenames are referred to in the detailed client workflow, i.e. filename.ext -> FILENAME.EXT
Remove suggestion to write a version of the root metadata without a version prefix. We only ever look for version-prefixed version of root metadata.

Fixes #184

joshuagl commented 2 years ago

Thanks for the review @mnm678, I've addressed your comments and clarified some more of the text in the "Writing consistent snapshots" section. Please take a look.

joshuagl commented 2 years ago

@lukpueh @trishankatdatadog could we get a second review here? Thank you!

joshuagl commented 2 years ago

Thanks for the review both. I committed Lukas' change, which dismissed existing reviews. Please take another look @mnm678 @lukpueh

joshuagl commented 2 years ago

Thanks for the suggestion Trishank. I've committed it and dismissed all reviews. Please take another look all @mnm678 @lukpueh @trishankatdatadog