Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

config: Simplify the paragraph contrasting diffIDs with layer digests #515

Merged

Conversation

wking
Copy link
Contributor

@wking wking commented Jan 19, 2017

@stevvooe and I couldn't agree on more detailed wording, and this paragraph was never normative anyway.

Spun off from #388 starting here. The new wording does not mention media types at all, so there's no reason to tangle it up with the rest of #388.

CC @stevvooe.

@wking
Copy link
Contributor Author

wking commented Jan 19, 2017

@stevvooe, you may want to close this PR and reopen your own with the same change (or whatever makes sense to you).

@@ -28,7 +28,7 @@ Changing it means creating a new derived image, instead of changing the existing
A layer DiffID is a SHA256 digest over the layer's uncompressed tar archive and serialized in the descriptor digest format, e.g., `sha256:a9561eb1b190625c9adb5a9513e72c4dedafc1cb2d4c5236c9a6957ec7dfd5a9`.
Layers must be packed and unpacked reproducibly to avoid changing the layer DiffID, for example by using tar-split to save the tar headers.

NOTE: the DiffID is different than the layer digest because it is taken over the uncompressed gzipped layer for `application/vnd.oci.image.layer.v1.tar+gzip` types.
Do not confuse DiffIDs with [layer digests](manifest.md#image-manifest-property-descriptions), often referenced in the manifest, which allow digests over compressed or uncompressed content.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One change: leave as a NOTE.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done with 4bd5ba79286846, in which I also dropped the “uncompressed” option. I'll restore the “uncompressed” choice in #388 (rebasing around this commit) after this PR lands.

@stevvooe
Copy link
Contributor

stevvooe commented Jan 19, 2017

LGTM after adding NOTE.

Approved with PullApprove

Trevor and I couldn't agree on more detailed wording [1], and this
paragraph was never normative anyway.

[1]: opencontainers#388 (comment)

Signed-off-by: Stephen J Day <[email protected]>
Signed-off-by: W. Trevor King <[email protected]>
@wking wking force-pushed the simplify-diffID-vs-layer-digest branch from 4bd5ba7 to 9286846 Compare January 19, 2017 23:37
@stevvooe
Copy link
Contributor

stevvooe commented Jan 19, 2017

LGTM

Approved with PullApprove

@philips
Copy link
Contributor

philips commented Jan 25, 2017

LGTM

Approved with PullApprove

@philips philips merged commit 51653ef into opencontainers:master Jan 25, 2017
@wking wking deleted the simplify-diffID-vs-layer-digest branch January 26, 2017 05:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants