Skip to content

Commit 9cc6137

Browse files
committed
config: Split annotations restrictions into one-per-sentence
As recommended by Daniel [1], although I've adjusted his recommended wording slightly and split the requirements into paragraphs. [1]: #654 (comment) Signed-off-by: W. Trevor King <[email protected]>
1 parent 2c8feeb commit 9cc6137

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

config.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -391,15 +391,19 @@ If a hook returns a non-zero exit code, then an error is logged and the remainin
391391

392392
**`annotations`** (object, OPTIONAL) contains arbitrary metadata for the container.
393393
This information MAY be structured or unstructured.
394-
Annotations MUST be a key-value map where both the key and value MUST be strings.
395-
While the value MUST be present, it MAY be an empty string.
394+
Annotations MUST be a key-value map.
395+
If there are no annotations then this property MAY either be absent or an empty map.
396+
397+
Keys MUST be strings.
396398
Keys MUST be unique within this map.
397399
Keys MUST NOT be an empty string.
398400
Keys SHOULD be named using a reverse domain notation - e.g. `com.example.myKey`.
399401
Keys using the `org.opencontainers` namespace are reserved and MUST NOT be used by subsequent specifications.
400-
If there are no annotations then this property MAY either be absent or an empty map.
401402
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown annotation key.
402403

404+
Values MUST be strings.
405+
Values MAY be an empty string.
406+
403407
```json
404408
"annotations": {
405409
"com.example.gpu-cores": "2"

0 commit comments

Comments
 (0)