-
Notifications
You must be signed in to change notification settings - Fork 645
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
cmd/oci-image-tool: add manuals #180
Conversation
/cc @s-urbaniak |
If we're getting more formal about documenting oci-image-tool, I |
if maintainers are ok with that, I'll do that - right now I don't think it's necessary, |
On Fri, Jul 22, 2016 at 07:49:41AM -0700, Antonio Murdaca wrote:
Hopefully oci-image-tool will be mature and well-used soon ;). |
I'd still have a README - why not? |
On Fri, Jul 22, 2016 at 07:58:11AM -0700, Antonio Murdaca wrote:
A README should defer to the man-page (opencontainers/runtime-tools#47) to |
but we don't have a man page yet and what I've added is dry enough for now - I can remove the Usage to be referenced in future man pages but examples are good there and ocitools have them as well |
On Fri, Jul 22, 2016 at 08:07:10AM -0700, Antonio Murdaca wrote:
I'm just saying that if the decision is “we don't want a man page yet |
that's not the issue - I'm only saying a README.md with examples can go in w/o waiting to have man pages and that can come as a follow on (by me as well of course). Anyhow, I'll work on man pages asap |
What examples would you put in a README that wouldn't go in the man page? |
I'm not saying they should not go in the man page - I'm saying this is adding some example the same as the https://github.com/opencontainers/ocitools README is doing (https://github.com/opencontainers/ocitools/blob/master/man/ocitools-validate.1.md doesn't have examples in it but the README does, so take this PR as the README side of what ocitools already contain). I'm sure either of the two isn't following the other... as said, I'll add some man pages stub |
On Fri, Jul 22, 2016 at 08:31:32AM -0700, Antonio Murdaca wrote:
Ah, I think that should be fixed in ocitools. Filed as |
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
man pages added... |
**oci-image-tool unpack** [src] [dest] [flags] | ||
|
||
# DESCRIPTION | ||
`oci-image-tool unpack` unpacks a given OCI image into a directory suitable to be used with `runc`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's probably worth drawing a clear distinction between unpack
and create-runtime-bundle
here. That distinction is mostly around rootfs-or-not and config translation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure, any suggestion on the language?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On Fri, Jul 22, 2016 at 10:25:35AM -0700, Antonio Murdaca wrote:
+# DESCRIPTION
+oci-image-tool unpack
unpacks a given OCI image into a directory suitable to be used withrunc
.sure, any suggestion on the language?
For unpack, something like:
Validates an application/vnd.oci.image.manifest.v1+json and unpacks
its layered filesystem to DEST.
For create-runtime-bundle, something like:
Validates an application/vnd.oci.image.manifest.v1+json and unpacks
its layered filesystem to DEST/rootfs, although the target directory
is configurable with --rootfs. See oci-image-tool-unpack(1) for
more details on this process.
Also translates the referenced config from
application/vnd.oci.image.serialization.config.v1+json to a
runtime-spec's config.json.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On Fri, Jul 22, 2016 at 10:35:50AM -0700, W. Trevor King wrote:
Also translates the referenced config from
application/vnd.oci.image.serialization.config.v1+json to a
runtime-spec's config.json.
Probably worth working in DEST/config.json there somewhow. Maybe:
Also translates the referenced config from
application/vnd.oci.image.serialization.config.v1+json to a
runtime-spec-compatible DEST/config.json.
On Fri, Jul 22, 2016 at 10:13:40AM -0700, Antonio Murdaca wrote:
They look pretty good to me. Do we expect additional command-line |
I put them there just in case we'll have a dedicated repo for oci-image-tool and generally to keep them there not to clutter the repo root |
On Fri, Jul 22, 2016 at 10:31:26AM -0700, Antonio Murdaca wrote:
+1 to that 1 ;). |
I will @wking |
Generated with: $ sed -i 's/oci-image-tools/oci-image-tool/g' $(git grep -l oci-image-tools) Typos are from e60ff1d (cmd/oci-image-tool: add manuals, 2016-07-22, opencontainers#180). Signed-off-by: W. Trevor King <wking@tremily.us>
Signed-off-by: Antonio Murdaca runcom@redhat.com