Skip to content
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.

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

config.md: small fixes #669

Merged
merged 1 commit into from
May 11, 2017
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,24 +132,24 @@ Note: Any OPTIONAL field MAY also be set to null, which is equivalent to being a

- **Env** *array of strings*, OPTIONAL

Entries are in the format of `VARNAME="var value"`.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is actually a good catch. These are NOT quoted.

Good job!

Entries are in the format of `VARNAME=VARVALUE`.
These values act as defaults and are merged with any specified when creating a container.

- **Entrypoint** *array of strings*, OPTIONAL

A list of arguments to use as the command to execute when the container starts.
This value acts as a default and is replaced by an entrypoint specified when creating a container.
These values act as default and are replaced by an entrypoint specified when creating a container.
Copy link
Contributor

Choose a reason for hiding this comment

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

"may be replaced".

Copy link
Contributor

Choose a reason for hiding this comment

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

"as defaults"


- **Cmd** *array of strings*, OPTIONAL

Default arguments to the entrypoint of the container.
These values act as defaults and are replaced with any specified when creating a container.
These values act as defaults and are replaced by any specified when creating a container.
Copy link
Contributor

Choose a reason for hiding this comment

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

"may be replaced"

If an `Entrypoint` value is not specified, then the first entry of the `Cmd` array SHOULD be interpreted as the executable to run.

- **Volumes** *object*, OPTIONAL

A set of directories which SHOULD be created as data volumes in a container running this image.
If a file or folder exists within the image with the same path as a data volume, that file or folder is replaced with the data volume and is never merged.
If a file or folder exists within the image with the same path as a data volume, that file or folder is replaced by the data volume and is never merged.
**NOTE:** This JSON structure value is unusual because it is a direct JSON serialization of the Go type `map[string]struct{}` and is represented in JSON as an object mapping its keys to an empty object.

- **WorkingDir** *string*, OPTIONAL
Expand Down