config.md: add empty limit for key of annotations #645
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
empty key does not make any senses, we should limit it. Signed-off-by: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
wking
reviewed
Jan 3, 2017
| @@ -388,7 +388,7 @@ The semantics are the same as `Path`, `Args` and `Env` in [golang Cmd](https://g | |||
| This information MAY be structured or unstructured. | |||
| Annotations MUST be a key-value map where both the key and value MUST be strings. | |||
| While the value MUST be present, it MAY be an empty string. | |||
| Keys MUST be unique within this map, and best practice is to namespace the keys. | |||
| Keys MUST be unique and MUST NOT be an empty string within this map, and best practice is to namespace the keys. | |||
There was a problem hiding this comment.
I'd rather not split “unique within this map”. How about splitting each idea into its own sentence:
Keys MUST be unique within this map.
Keys MUST NOT be an empty string.
We can drop the “best practice” portion, because the following line is “Keys SHOULD be named using a reverse domain notation…”, which covers that idea more explicitly. If we want to give explicit namespacing advice to annotation-spec devs without access to a domain name, I'd rather address that directly (in a separate PR?).
|
LGTM |
|
LGTM |
wking
added a commit
to wking/opencontainer-runtime-spec
that referenced
this pull request
May 26, 2017
This condition landed in 27a05de (Add text about extensions, 2016-06-26, opencontainers#510) with subsequent wording tweaks in 3f0440b (config.md: add empty limit for key of annotations, Dec 28 10:35:19 2016, opencontainers#645) and 2c8feeb (config: Bring "unique... within this map" back together, 2017-01-12, opencontainers#654). However, since eeaccfa (glossary: Make objects explicitly unordered and forbid duplicate names, 2016-09-27, opencontainers#584) we forbid duplicate keys on *all* objects (not just annotations), so this PR removes the redundant annotation-specific condition. Signed-off-by: W. Trevor King <wking@tremily.us>
wking
added a commit
to wking/opencontainer-runtime-spec
that referenced
this pull request
Jun 1, 2017
This condition landed in 27a05de (Add text about extensions, 2016-06-26, opencontainers#510) with subsequent wording tweaks in 3f0440b (config.md: add empty limit for key of annotations, Dec 28 10:35:19 2016, opencontainers#645) and 2c8feeb (config: Bring "unique... within this map" back together, 2017-01-12, opencontainers#654). However, since eeaccfa (glossary: Make objects explicitly unordered and forbid duplicate names, 2016-09-27, opencontainers#584) we forbid duplicate keys on *all* objects (not just annotations), so this PR removes the redundant annotation-specific condition. Signed-off-by: W. Trevor King <wking@tremily.us>
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.
empty key does not make any senses, we should limit it.
Signed-off-by: Ma Shimiao mashimiao.fnst@cn.fujitsu.com