jasder
/
runc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

config: Consistent Markdown/Go wording for 'platform' 

Don't mention OS and Arch, since they're covered by the list (in
Markdown) and Platform struct (in Go).  This gives us one less place
to update if we ever change the schema for the platform object.

Signed-off-by: W. Trevor King <wking@tremily.us>
This commit is contained in:
W. Trevor King 2016-08-02 23:37:47 -07:00
parent f2cc9fdb60
commit 57fc2ca54c
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
config.md
View File

@ -200,6 +200,8 @@ _Note: For Solaris, uid and gid specify the uid and gid of the process inside th
## Platform
**`platform`** specifies the configuration's target platform.
* **`os`** (string, required) specifies the operating system family this image targets.
The runtime MUST generate an error if it does not support the configured **`os`**.
Bundles SHOULD use, and runtimes SHOULD understand, **`os`** entries listed in the Go Language document for [`$GOOS`][go-environment].

2
specs-go/config.go
View File

@ -6,7 +6,7 @@ import "os"
type Spec struct {
// Version of the Open Container Runtime Specification with which the bundle complies.
Version string `json:"ociVersion"`
// Platform is the host information for OS and Arch.
// Platform specifies the configuration's target platform.
Platform Platform `json:"platform"`
// Process is the container's main process.
Process Process `json:"process"`