Skip to content

config: DRY up labels with annotations reference #639

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
jonboulle merged 1 commit into from
Apr 6, 2017
Merged

config: DRY up labels with annotations reference #639

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
7 changes: 1 addition & 6 deletions config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,12 +160,7 @@ Note: Any OPTIONAL field MAY also be set to null, which is equivalent to being a
- **Labels** *object*, OPTIONAL

The field contains arbitrary metadata for the container.
Labels MUST be a key-value map where both the key and value MUST be strings.
Keys MUST be unique within this map, and best practice is to namespace the keys.
Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`.
Keys using the `org.opencontainers.image` namespace are reserved and MUST NOT be used by subsequent specifications.
If there are no labels then this property MAY either be absent or an empty map.
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown labels key.
This OPTIONAL property MUST use the [annotation rules](annotations.md#rules).
Copy link
Contributor

@wking wking Apr 5, 2017

Choose a reason for hiding this comment

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

While the other annotations references (e.g. here) use the “This OPTIONAL property…” pattern, config.md puts the OPTIONAL/REQUIRED-ness in the same line as the property name (while manifest.md does not). My preferred larger fix would be to follow runtime-spec and consistently declare OPTIONAL/REQUIRED-ness in the same line as the property name, but if that's too big to bite off here, I'd rather reword this line to not repeat OPTIONAL. Something like:

This property MUST use the annotation rules.

would be fine.

Copy link
Contributor

@jonboulle jonboulle Apr 6, 2017

Choose a reason for hiding this comment

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

follow up?

Copy link
Contributor

@wking wking Apr 6, 2017

Choose a reason for hiding this comment

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

follow up?

Filed as #642.


- **StopSignal** *string*, OPTIONAL

Expand Down