Skip to content

Commit

Permalink
Merge pull request #212 from mrunalp/rename
Browse files Browse the repository at this point in the history
Rename ocitools to oci-runtime-tool
  • Loading branch information
Mrunal Patel authored Sep 14, 2016
2 parents 4472a78 + a774b91 commit a4ce1e5
Show file tree
Hide file tree
Showing 14 changed files with 99 additions and 99 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ _testmain.go

# Compiled binaries
oci
/ocitools
/oci-runtime-tool
/runtimetest

*.1
Expand Down
2 changes: 1 addition & 1 deletion Godeps/Godeps.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 7 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@ BUILDTAGS=
export GOPATH:=$(CURDIR)/Godeps/_workspace:$(GOPATH)

all:
go build -tags "$(BUILDTAGS)" -o ocitools ./cmd/ocitools
go build -tags "$(BUILDTAGS)" -o oci-runtime-tool ./cmd/oci-runtime-tool
go build -tags "$(BUILDTAGS)" -o runtimetest ./cmd/runtimetest

.PHONY: man
man:
go-md2man -in "man/ocitools.1.md" -out "ocitools.1"
go-md2man -in "man/ocitools-generate.1.md" -out "ocitools-generate.1"
go-md2man -in "man/ocitools-validate.1.md" -out "ocitools-validate.1"
go-md2man -in "man/oci-runtime-tool.1.md" -out "oci-runtime-tool.1"
go-md2man -in "man/oci-runtime-tool-generate.1.md" -out "oci-runtime-tool-generate.1"
go-md2man -in "man/oci-runtime-tool-validate.1.md" -out "oci-runtime-tool-validate.1"

install: man
install -d -m 755 $(BINDIR)
install -m 755 ocitools $(BINDIR)
install -m 755 oci-runtime-tool $(BINDIR)
install -d -m 755 $(PREFIX)/share/man/man1
install -m 644 *.1 $(PREFIX)/share/man/man1
install -d -m 755 $(PREFIX)/share/bash-completion/completions
install -m 644 completions/bash/ocitools $(PREFIX)/share/bash-completion/completions
install -m 644 completions/bash/oci-runtime-tool $(PREFIX)/share/bash-completion/completions

clean:
rm -f ocitools runtimetest *.1
rm -f oci-runtime-tool runtimetest *.1

.PHONY: test .gofmt .govet .golint

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# ocitools [![Build Status](https://travis-ci.org/opencontainers/ocitools.svg?branch=master)](https://travis-ci.org/opencontainers/ocitools)
# oci-runtime-tool [![Build Status](https://travis-ci.org/opencontainers/oci-runtime-tool.svg?branch=master)](https://travis-ci.org/opencontainers/oci-runtime-tool)

ocitools is a collection of tools for working with the [OCI runtime specification][runtime-spec].
oci-runtime-tool is a collection of tools for working with the [OCI runtime specification][runtime-spec].

## Generating an OCI runtime spec configuration files

[`ocitools generate`][generate.1] generates [configuration JSON][config.json] for an [OCI bundle][bundle].
[`oci-runtime-tool generate`][generate.1] generates [configuration JSON][config.json] for an [OCI bundle][bundle].
[OCI-compatible runtimes][runtime-spec] like [runC][] expect to read the configuration from `config.json`.

```sh
$ ocitools generate --output config.json
$ oci-runtime-tool generate --output config.json
$ cat config.json
{
"ociVersion": "0.5.0",
Expand All @@ -18,12 +18,12 @@ $ cat config.json

## Validating an OCI bundle

[`ocitools validate`][validate.1] validates an OCI bundle.
[`oci-runtime-tool validate`][validate.1] validates an OCI bundle.
The error message will be printed if the OCI bundle failed the validation procedure.

```sh
$ ocitools generate
$ ocitools validate
$ oci-runtime-tool generate
$ oci-runtime-tool validate
INFO[0000] Bundle validation succeeded.
```

Expand All @@ -49,5 +49,5 @@ Runtime runc passed validation
[runC]: https://github.com/opencontainers/runc
[runtime-spec]: https://github.com/opencontainers/runtime-spec

[generate.1]: man/ocitools-generate.1.md
[validate.1]: man/ocitools-validate.1.md
[generate.1]: man/oci-runtime-tool-generate.1.md
[validate.1]: man/oci-runtime-tool-validate.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import (
"strconv"
"strings"

"github.com/opencontainers/ocitools/generate"
rspec "github.com/opencontainers/runtime-spec/specs-go"
"github.com/opencontainers/runtime-tools/generate"
"github.com/urfave/cli"
)

Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion cmd/runtimetest/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ import (
"syscall"

"github.com/Sirupsen/logrus"
"github.com/opencontainers/ocitools/cmd/runtimetest/mount"
rspec "github.com/opencontainers/runtime-spec/specs-go"
"github.com/opencontainers/runtime-tools/cmd/runtimetest/mount"
"github.com/syndtr/gocapability/capability"
"github.com/urfave/cli"
)
Expand Down
Loading

0 comments on commit a4ce1e5

Please sign in to comment.