Skip to content

Use RFC_2119 style for config.md #444

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

Merged
crosbymichael merged 1 commit into from
May 23, 2016
Merged

Use RFC_2119 style for config.md #444

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,9 +213,9 @@ _Note: For Solaris, uid and gid specify the uid and gid of the process inside th
[**`platform.os`**](#platform) is used to lookup further platform-specific configuration.

* **`linux`** (object, optional) [Linux-specific configuration](config-linux.md).
This should only be set if **`platform.os`** is `linux`.
This SHOULD only be set if **`platform.os`** is `linux`.
* **`solaris`** (object, optional) [Solaris-specific configuration](config-solaris.md).
This should only be set if **`platform.os`** is `solaris`.
This SHOULD only be set if **`platform.os`** is `solaris`.
Copy link
Contributor

@wking wking May 23, 2016

Choose a reason for hiding this comment

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

Maybe the pattern here should be “This MUST NOT be set if platform.os is not $OS”? If you're writing a Linux config, you should not be setting solaris, but whether you set linux or not is up to you.

Copy link
Member

@vbatts vbatts May 23, 2016

Choose a reason for hiding this comment

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

I can't say that yet. Solaris has some linux compatibility modes. It could actually be feasible to have a Linux container that provides solaris configurations as well, IIUC


### Example (Linux)

Expand Down Expand Up @@ -308,7 +308,7 @@ The semantics are the same as `Path`, `Args` and `Env` in [golang Cmd](https://g
## Annotations

This OPTIONAL property contains arbitrary metadata for the container.
This information may be structured or unstructured.
This information MAY be structured or unstructured.
Annotations are key-value maps.

```json
Expand Down