From af0a9b76619173eb111329127a2254bba02ba13c Mon Sep 17 00:00:00 2001 From: Lei Jitang Date: Fri, 8 Sep 2017 09:49:03 +0800 Subject: [PATCH] Rename `oci-image-tool create` to `oci-image-tool create-bundle` `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 --- Makefile | 2 +- cmd/oci-image-tool/{create.go => bundle.go} | 2 +- completions/bash/oci-image-tool | 2 +- ...tool-create.1.md => oci-image-tool-create-bundle.1.md} | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) rename cmd/oci-image-tool/{create.go => bundle.go} (99%) rename man/{oci-image-tool-create.1.md => oci-image-tool-create-bundle.1.md} (72%) diff --git a/Makefile b/Makefile index 1ff6efa..ba8680c 100644 --- a/Makefile +++ b/Makefile @@ -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" diff --git a/cmd/oci-image-tool/create.go b/cmd/oci-image-tool/bundle.go similarity index 99% rename from cmd/oci-image-tool/create.go rename to cmd/oci-image-tool/bundle.go index 3b5f518..4542edd 100644 --- a/cmd/oci-image-tool/create.go +++ b/cmd/oci-image-tool/bundle.go @@ -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", Action: createHandle, Flags: []cli.Flag{ diff --git a/completions/bash/oci-image-tool b/completions/bash/oci-image-tool index a6a2157..2c1ae30 100644 --- a/completions/bash/oci-image-tool +++ b/completions/bash/oci-image-tool @@ -202,7 +202,7 @@ _oci-image-tool() { shopt -s extglob local commands=( - create + create-bundle validate unpack ) diff --git a/man/oci-image-tool-create.1.md b/man/oci-image-tool-create-bundle.1.md similarity index 72% rename from man/oci-image-tool-create.1.md rename to man/oci-image-tool-create-bundle.1.md index 33ad68e..b3c0498 100644 --- a/man/oci-image-tool-create.1.md +++ b/man/oci-image-tool-create-bundle.1.md @@ -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`. @@ -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 [...] ```