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

description: validates manifest when unpack #37

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

description: validates manifest when unpack #37

wants to merge 1 commit into from

Conversation

xiekeyang
Copy link
Contributor

Actually, the validation object before unpack is whole manifest schema, not only its own media type.
Signed-off-by: xiekeyang xiekeyang@huawei.com

@@ -8,7 +8,7 @@ oci-unpack \- Unpack an image or image source layout
**oci-unpack** [src] [dest] [flags]

# DESCRIPTION
`oci-unpack` validates an application/vnd.oci.image.manifest.v1+json and unpacks its layered filesystem to `dest`.
`oci-unpack` validates an [Image Manifest](/~https://github.com/opencontainers/image-spec/blob/master/manifest.md#image-manifest) and unpacks its layered filesystem to `dest`.
Copy link
Contributor

Choose a reason for hiding this comment

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

We still don't have a Makefile rule to build man pages from this Markdown source, but go-md2man (used by runtime-tools) handles links poorly. I suggest we avoid them until we have more clarity on how the man pages will be generated.

I'm fine with the original wording, because to me “validated an application/vnd.oci.image.manifest.v1+json” means the whole Merkle tree, not just a ref media type claim on the root object. However, I'd be fine with an additional sentence that made the full-tree validation explicit. Something like:

The entire Merkle tree rooted on the manifest blob is validated.

@xiekeyang
Copy link
Contributor Author

@wking
I update it, to present the description as,

oci-unpack validates an application/vnd.oci.image.manifest.v1+json, with entire Merkle tree rooted on it, and unpacks its layered filesystem to dest.

If it is OK?

@wking
Copy link
Contributor

wking commented Oct 21, 2016

“with” → “and the”, but otherwise e0a2f66 looks good to me.

Signed-off-by: xiekeyang <xiekeyang@huawei.com>
@xiekeyang
Copy link
Contributor Author

.@wking I change with to and the, although I fell and.., and not very smooth.

@wking
Copy link
Contributor

wking commented Oct 21, 2016

f256b57 looks good to me. Maybe the “…, and …, and” would feel better to you if we use parens?

oci-unpack validates an application/vnd.oci.image.manifest.v1+json (and the entire Merkle tree rooted on it) and unpacks its layered filesystem to dest.

@vbatts
Copy link
Member

vbatts commented Feb 14, 2017

LGTM

Approved with PullApprove

@zhouhao3
Copy link

Please rebase.

@zhouhao3
Copy link

@xiekeyang Please rebase.

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.

4 participants