Skip to content

Commit c763e64

Browse files
committed
config: Move valid-value rules to their own section
This wording just landed via 718f9f3 (origin/pr/673) minor narrative cleanup regarding config compatibility, 2017-01-30, opencontainers#673), but the rule is generic and not unique to platform-specific properties. Also adjust the wording somewhat to match the more established wording from the "Extensibility" section. Signed-off-by: W. Trevor King <wking@tremily.us>
1 parent 2e2d568 commit c763e64

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

config.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,6 @@ For Windows based systems the user structure has the following fields:
292292

293293
[**`platform.os`**](#platform) is used to specify platform-specific configuration.
294294
Runtime implementations MAY support any valid values for platform-specific fields as part of this configuration.
295-
Implementations MUST error out when invalid values are encountered and MUST generate an error message and error out when encountering valid values it chooses to not support.
296295

297296
* **`linux`** (object, OPTIONAL) [Linux-specific configuration](config-linux.md).
298297
This MAY be set if **`platform.os`** is `linux` and MUST NOT be set otherwise.
@@ -416,6 +415,11 @@ Values MAY be an empty string.
416415
Implementations that are reading/processing this configuration file MUST NOT generate an error if they encounter an unknown property.
417416
Instead they MUST ignore unknown properties.
418417

418+
## Valid values
419+
420+
Implementations that are reading/processing this configuration file MUST generate an error when invalid or unsupported values are encountered.
421+
Unless support for a valid value is explicitly required, runtimes MAY choose which subset of the valid values it will support.
422+
419423
## Configuration Schema Example
420424

421425
Here is a full example `config.json` for reference.

0 commit comments

Comments
 (0)