Rename oci-image-tool create to oci-image-tool create-bundle
#182
Conversation
This file contains 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
coolljt0725
force-pushed
the
create_bundle
branch
2 times, most recently
from
19de833
to
af0a9b7
Compare
`oci-image-tool create` is confusing, rename it to `create-bundle`, and we may have `create-layer` in future which is infligh in and we may have `create-image` in future. Signed-off-by: Lei Jitang <leijitang@huawei.com>
|
On Thu, Sep 07, 2017 at 08:27:01AM +0000, Lei Jitang wrote:
`oci-image-tool create` is confusing, rename it to `create-bundle`,
and we may have `create-layer` in future which infligh in #8.
opencontainers/image-spec#467 is still open and
opencontainers/image-spec#554 was rejected, but I still prefer
‘unpack’ for this sort of thing [1]. That focuses the name on the
image-spec object (the manifest and blobs) that are being unpacked,
instead of on the runtime-spec object (the bundle) that is being
created. To distinguish from other unpacking (e.g. unpacking a single
layer, or a stack of layers, just a config, etc.), I'd recommend
‘unpack manifest’ (or if you prefer, ‘unpack-manifest’). Unpacking a
single layer would be ‘unpack layer’, unpacking multiple layers would
be ‘unpack layers’ and unpacking an image-spec config into a
runtime-spec config would be ‘unpack config’ or ‘translate config’.
[1]: https://github.com/wking/image-spec/blob/cb65bdf4c29e7967b0ebe876809c8292d3bd3628/spec.md#actions
|
zhouhao3
reviewed
Oct 12, 2017
| @@ -76,7 +76,7 @@ func createHandle(context *cli.Context) error { | |||
| } | |||
|
|
|||
| var createCommand = cli.Command{ | |||
| Name: "create", | |||
| Name: "create-bundle", | |||
| Usage: "Create an OCI image runtime bundle", | |||
There was a problem hiding this comment.
Is it better to change this file name to create-bundle.go?
|
I tend to agree with #182 (comment) - unpack nomenclature seems a lot more intuitive here (especially considering this is a superset of the |
|
@jonboulle @wking we already has a |
|
On Thu, Oct 19, 2017 at 01:17:08AM +0000, Lei Jitang wrote:
… we already has a `oci-image-tool unpack` which only unpack the
layers to a rootfs, so do you mean to use `oci-image-tool unpack` to
create runtime bundle and use `oci-image-tool unpack-layers` to
unpack the layers to a rootfs?
I'd rather avoid an unqualified ‘unpack’. I don't mind about
hyphenated or unhyphenated versions, but here's the unhyphenated forms
of what I'm thinking (based on my earlier suggestions in [1]):
* ‘unpack layers’ unpacks a stack of layers (as referenced by a
manifest). Currently this is ‘unpack’.
* ‘unpack layer’ unpacks a single layer (possibly into an existing,
populated directory). We don't have a command for this at the
moment.
* ‘translate config’ (or ‘unpack config’) for converting a
configuration from the image-spec form to the runtime-spec form (and
possibly vice versa via --from and --to options) and writing the
result to stdout.
* ‘unpack manifest’ combining ‘unpack layers’ and ‘translate config’
with the config written to config.json. Currently this is ‘create’.
[1]: #182 (comment)
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
oci-image-tool createis confusing, rename it tocreate-bundle,and we may have
create-layerin future which is infligh in#8
and we may have
create-imagein future.Signed-off-by: Lei Jitang leijitang@huawei.com