Skip to content

Commit eb82bad

Browse files
committed
config: Link platform:"..." JSON tags with protocol slugs
So that the semantics are clear. The platform/protocol disconnect is unfortunate. "Protocol" was chosen in de3f1af (Remove language around Solaris being optional as it is covered in compliance language, 2016-08-17, #527) because we may have compliance subsets that aren't linked to platforms [2]. I'd be open to renaming the JSON tag from platform:"..." -> protocol:"...", but that's probably more change than it's worth. [1]: #527 (comment) Signed-off-by: W. Trevor King <[email protected]>
1 parent 00b07e8 commit eb82bad

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

config.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
The container's top-level directory MUST contain a configuration file called `config.json`.
44
The canonical schema is defined in this document, but there is a JSON Schema in [`schema/config-schema.json`](schema/config-schema.json) and Go bindings in [`specs-go/config.go`](specs-go/config.go).
5+
For properties that are only defined for some [protocols](README.md#compliance), the Go property has a `platform` tag listing those protocols (e.g. `platform:"linux,solaris"`).
56

67
The configuration file contains metadata necessary to implement standard operations against the container.
78
This includes the process to run, environment variables to inject, sandboxing features to use, etc.

0 commit comments

Comments
 (0)