Skip to content

Rename oci-image-tool create to oci-image-tool create-bundle #182

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.

Sign up for GitHub

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

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

Rename oci-image-tool create to oci-image-tool create-bundle #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion cmd/oci-image-tool/create.go → cmd/oci-image-tool/bundle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link

@zhouhao3 zhouhao3 Oct 12, 2017

Choose a reason for hiding this comment

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

Is it better to change this file name to create-bundle.go?

Action: createHandle,
Flags: []cli.Flag{
Expand Down
2 changes: 1 addition & 1 deletion completions/bash/oci-image-tool
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ _oci-image-tool() {
shopt -s extglob

local commands=(
create
create-bundle
validate
unpack
)
Expand Down
8 changes: 4 additions & 4 deletions man/oci-image-tool-create.1.md → man/oci-image-tool-create-bundle.1.md
View file
Open in desktop
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