Skip to content

Commit f2cc9fd

Browse files
committed
config: Update 'OpenContainer specification' wording
Catch up with the spec title from faad7e0 (README: title rename, 2016-04-04, #365). Also make the Go comment consistent with the Markdown spec (no need to maintain two phrasings for the same idea). The only difference between the phrasings is now some shuffling at the beginning to start off with the property name (to keep godoc happy). The JSON Schema entry (in defs.json) is different too, because it has to apply to both the configuration and state JSON, so mentioning "bundle" makes less sense than mentioning "document". Signed-off-by: W. Trevor King <[email protected]>
1 parent 95a6ecf commit f2cc9fd

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Below is a detailed description of each field defined in the configuration forma
1010

1111
## Specification version
1212

13-
* **`ociVersion`** (string, required) MUST be in [SemVer v2.0.0](http://semver.org/spec/v2.0.0.html) format and specifies the version of the OpenContainer specification with which the bundle complies.
14-
The OpenContainer spec follows semantic versioning and retains forward and backward compatibility within major versions.
13+
* **`ociVersion`** (string, required) MUST be in [SemVer v2.0.0](http://semver.org/spec/v2.0.0.html) format and specifies the version of the Open Container Runtime Specification with which the bundle complies.
14+
The Open Container Runtime Specification follows semantic versioning and retains forward and backward compatibility within major versions.
1515
For example, if an implementation is compliant with version 1.0.1 of the spec, it is compatible with the complete 1.x series.
1616

1717
### Example

schema/defs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"description": "Definitions used throughout the OpenContainer Specification",
2+
"description": "Definitions used throughout the Open Container Runtime Specification",
33
"definitions": {
44
"int8": {
55
"type": "integer",

specs-go/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import "os"
44

55
// Spec is the base configuration for the container.
66
type Spec struct {
7-
// Version is the version of the specification that is supported.
7+
// Version of the Open Container Runtime Specification with which the bundle complies.
88
Version string `json:"ociVersion"`
99
// Platform is the host information for OS and Arch.
1010
Platform Platform `json:"platform"`

0 commit comments

Comments
 (0)