config: DRY up labels with annotations reference #639
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
from opencontainers#635 (comment) it was clear that all the rules for `Labels` are the same as annotations, so let's DRY that up a bit. Signed-off-by: Vincent Batts <[email protected]>
|
cc @stevvooe how's this? |
|
oh, hmm, seems reasonable enough |
wking
reviewed
Apr 5, 2017
| 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). |
There was a problem hiding this comment.
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.
|
LGTM |
|
lgtm |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
from
#635 (comment)
it was clear that all the rules for
Labelsare the same asannotations, so let's DRY that up a bit.
Signed-off-by: Vincent Batts [email protected]