Skip to content

Commit

Permalink
man/ocitools-generate.1: Copy-edits for the description
Browse files Browse the repository at this point in the history
Also adjust the copy of this text in the README.

I've left the reference-style links out of the man page, since
go-md2man doesn't seem to be able to handle them, and instead creates
troff with just the link targets:

  \[la]man/ocitools-generate.1.md\[ra] generates a
  \[la]https://github.com/opencontainers/runtime-spec/blob/master/config.md\[ra] for an
  ...

Signed-off-by: W. Trevor King <wking@tremily.us>
  • Loading branch information
wking committed Apr 28, 2016
1 parent ba4a9a0 commit bb11739
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ ocitools is a collection of tools for working with the [OCI runtime specificatio

## Generating an OCI runtime spec configuration files

[`ocitools generate`][generate.1] is used to generate a `config.json` ([OCI spec][runtime-spec] file) to be used to instantiate an OCI container.
This `config.json` file can be placed into a directory and used by an OCI compatable runtime like [**runc**][runC] to run a container.
[`ocitools generate`][generate.1] generates a [`config.json`][config.json] for an [OCI bundle][bundle].
This `config.json` file can be placed into a directory and used by an [OCI compatable runtime][runtime-spec] like [runC][] to run a container.

```sh
$ ocitools generate
Expand Down Expand Up @@ -43,6 +43,8 @@ validating sysctls
Runtime runc passed validation
```
[bundle]: https://github.com/opencontainers/runtime-spec/blob/master/bundle.md
[config.json]: https://github.com/opencontainers/runtime-spec/blob/master/config.md
[runC]: https://github.com/opencontainers/runc
[runtime-spec]: https://github.com/opencontainers/runtime-spec
Expand Down
8 changes: 4 additions & 4 deletions man/ocitools-generate.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ ocitools-generate - Generate a config.json for an OCI container
[**--uts**]

# DESCRIPTION
**ocitools generate** is used to generate a config.json (OCI spec file) to be used to
instantiate an OCI container. This config.json file can be placed into a
directory and used by an OCI compatable runtime like **runc** to run a
container.

`ocitools generate` generates a `config.json` for an OCI bundle. This
`config.json` file can be placed into a directory and used by an OCI
compatable runtime like runC to run a container.

# OPTIONS
**--apparmor**="PROFILE"
Expand Down

0 comments on commit bb11739

Please sign in to comment.