Skip to content

man: Shift examples from the README to man pages #142

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

Closed
wking wants to merge 2 commits into from
Closed

man: Shift examples from the README to man pages #142

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a357a43
man/ocitools-generate: '#' -> '$' when you don't need root
wking Jul 22, 2016
3e10088
man: Shift examples from the README to man pages
wking Jul 22, 2016
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
14 changes: 0 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,11 @@ ocitools is a collection of tools for working with the [OCI runtime specificatio
[`ocitools 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
$ cat config.json
{
"ociVersion": "0.5.0",
…
}
```

## Validating an OCI bundle

[`ocitools 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
INFO[0000] Bundle validation succeeded.
```

## Testing OCI runtimes
Copy link
Member

@runcom runcom Jul 22, 2016 •
edited
Loading

Choose a reason for hiding this comment

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

why this example is here? shouldn't it go the man page as well?

Copy link
Member

@runcom runcom Jul 22, 2016

Choose a reason for hiding this comment

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

I guess the question is: shouldn't testruntime.sh be a part of ocitools?

Copy link
Contributor Author

@wking wking Jul 22, 2016

Choose a reason for hiding this comment

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

On Fri, Jul 22, 2016 at 09:43:41AM -0700, Antonio Murdaca wrote:

Testing OCI runtimes

I guess the question is: shouldn't testruntime.sh be a part of ocitools?

Yes, but it's hard to do right ;). See discussion in #61 and #98 (I'm
partial to 1 ;).


Expand Down
10 changes: 10 additions & 0 deletions man/ocitools-generate.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,16 @@ inside of the container.

# EXAMPLES

## Generate a default configuration

With choices that the ocitools developers think are sane.

$ ocitools generate
{
"ociVersion": "0.5.0",
…
}

## Generating container in read-only mode

During container image development, containers often need to write to the image
Expand Down
17 changes: 17 additions & 0 deletions man/ocitools-validate.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,23 @@ Validate an OCI bundle
launching this container"), but will fail with it ("this host is not capable
of launching this container").

# EXAMPLES

Generate a basic configuration:

$ ocitools generate --output config.json
$ mkdir rootfs

Validate it for specification compliance:

$ ocitools validate
Bundle validation succeeded.

Check whether it will run on your current host:

$ ocitools validate --host-specific
Bundle validation succeeded.

# SEE ALSO
**ocitools**(1)

Expand Down