cmd/oci-image-tool/man: clarify unpack and create-runtime-bundle description #241
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| more details on this process. | ||
|
|
||
| Also translates the referenced config from application/vnd.oci.image.serialization.config.v1+json to a | ||
| runtime-spec-compatible `DEST/config.json`. |
Contributor
There was a problem hiding this comment.
This is a lot to put in NAME. Can we put the new stuff under DESCRIPTION?
Member
Author
|
@wking PTAL fixed your comments (fat fingers) |
| **oci-image-tool create-runtime-bundle** [src] [dest] [flags] | ||
|
|
||
| # DESCRIPTION | ||
| `oci-image-tool create-runtime-bundle` generates an [OCI bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md) from an [OCI image layout](https://github.com/opencontainers/image-spec/blob/master/image-layout.md). |
Contributor
There was a problem hiding this comment.
I'm not sure how we intend to compile these to troff, but ocitools uses go-md2man, which currently handles links poorly:
$ go-md2man -in oci-image-tool-create-runtime-bundle.1.md -out oci-image-tool-create-runtime-bundle.1
$ grep -A4 DESCRIPTION oci-image-tool-create-runtime-bundle.1
.SH DESCRIPTION
.PP
\fB\fCoci\-image\-tool create\-runtime\-bundle\fR generates an
\[la]https://github.com/opencontainers/runtime-spec/blob/master/bundle.md\[ra] from an
\[la]https://github.com/opencontainers/image-spec/blob/master/image-layout.md\[ra]\&.
So I recommend we drop this line now that we're adding the additional detail below. Just start with:
`oci-image-tool create-runtime-bundle` validates an application/vnd.oci.image.manifest.v1+json…
Member
Author
|
@wking took care of your comments |
| # DESCRIPTION | ||
| `oci-image-tool unpack` unpacks a given OCI image into a directory suitable to be used with `runc`. | ||
|
|
||
| `oci-image-tool unpack` it validates an application/vnd.oci.image.manifest.v1+json and unpacks its layered filesystem to `DEST`. |
Member
Author
|
@wking fixed again |
Contributor
|
1ff9da5 looks good to me. Sorry about waffling on DEST / dest :p.
|
Member
Author
|
@philips PTAL |
|
|
||
| # DESCRIPTION | ||
| `oci-image-tool create-runtime-bundle` generates an [OCI bundle](https://github.com/opencontainers/runtime-spec/blob/master/bundle.md) from an [OCI image layout](https://github.com/opencontainers/image-spec/blob/master/image-layout.md). | ||
| `oci-image-tool create-runtime-bundle` validates an application/vnd.oci.image.manifest.v1+json and unpacks |
Contributor
There was a problem hiding this comment.
wrapping is weird/inconsistent
Member
Author
There was a problem hiding this comment.
I might just put everything on a single line (or wrap at 80?)
…ription Signed-off-by: Antonio Murdaca <[email protected]>
Contributor
|
1ec6417 looks good to me too.
|
Contributor
|
LGTM |
Contributor
|
cc @opencontainers/image-spec-maintainers |
Contributor
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Taking care of https://github.com/opencontainers/image-spec/pull/180/files#r71914328
/cc @wking @philips
Signed-off-by: Antonio Murdaca [email protected]