From 57fc2ca54c8a4afca53c520d8d4a3e24d5c12764 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Tue, 2 Aug 2016 23:37:47 -0700 Subject: [PATCH] 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 --- config.md | 2 ++ specs-go/config.go | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/config.md b/config.md index a3f3ab27..19ef4ccb 100644 --- a/config.md +++ b/config.md @@ -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]. diff --git a/specs-go/config.go b/specs-go/config.go index 7e1bdf4a..cb4cae81 100644 --- a/specs-go/config.go +++ b/specs-go/config.go @@ -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"`