Skip to content

Commit

Permalink
Rename oci-image-tool create to oci-image-tool create-bundle
Browse files Browse the repository at this point in the history
`oci-image-tool create` is confusing, rename it to `create-bundle`,
and we may have `create-layer` in future which is infligh in
opencontainers#8
and we may have `create-image` in future.

Signed-off-by: Lei Jitang <[email protected]>
  • Loading branch information
coolljt0725 committed Sep 7, 2017
1 parent f3b94b3 commit 19de833
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ all: tool man
.PHONY: man
man:
go-md2man -in "man/oci-image-tool.1.md" -out "oci-image-tool.1"
go-md2man -in "man/oci-image-tool-create.1.md" -out "oci-image-tool-create.1"
go-md2man -in "man/oci-image-tool-create-bundle.1.md" -out "oci-image-tool-create-bundle.1"
go-md2man -in "man/oci-image-tool-unpack.1.md" -out "oci-image-tool-unpack.1"
go-md2man -in "man/oci-image-tool-validate.1.md" -out "oci-image-tool-validate.1"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ func createHandle(context *cli.Context) error {
}

var createCommand = cli.Command{
Name: "create",
Name: "create-bundle",
Usage: "Create an OCI image runtime bundle",
Action: createHandle,
Flags: []cli.Flag{
Expand Down
2 changes: 1 addition & 1 deletion completions/bash/oci-image-tool
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ _oci-image-tool() {
shopt -s extglob

local commands=(
create
create-bundle
validate
unpack
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
% OCI Community
% JULY 2016
# NAME
oci-image-tool create \- Create an OCI runtime bundle
oci-image-tool create-bundle \- Create an OCI runtime bundle

# SYNOPSIS
**oci-image-tool create** [src] [dest] [OPTIONS]
**oci-image-tool create-bundle** [src] [dest] [OPTIONS]

# DESCRIPTION
`oci-image-tool create` 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.
`oci-image-tool create-bundle` 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.config.v1+json to a
runtime-spec-compatible `dest/config.json`.
Expand All @@ -35,7 +35,7 @@ runtime-spec-compatible `dest/config.json`.
```
$ skopeo copy docker://busybox oci:busybox-oci
$ mkdir busybox-bundle
$ oci-image-tool create --ref latest busybox-oci busybox-bundle
$ oci-image-tool create-bundle --ref latest busybox-oci busybox-bundle
$ cd busybox-bundle && sudo runc run busybox
[...]
```
Expand Down

0 comments on commit 19de833

Please sign in to comment.