From 886424a3145b2192ecada80a1d8f587902ef8542 Mon Sep 17 00:00:00 2001
From: "W. Trevor King" <wking@tremily.us>
Date: Mon, 2 May 2016 11:04:39 -0700
Subject: [PATCH] config: Split platform-specific configuration into its own
 section (#414)

To make it clear that the whole 'linux' section is optional.

Signed-off-by: W. Trevor King <wking@tremily.us>
---
 config-linux.md |  2 +-
 config.md       | 28 +++++++++++++++++++++++++---
 2 files changed, 26 insertions(+), 4 deletions(-)

diff --git a/config-linux.md b/config-linux.md
index f37670dee..5135eff00 100644
--- a/config-linux.md
+++ b/config-linux.md
@@ -1,7 +1,7 @@
 # Linux-specific Container Configuration
 
+This document describes the schema for the [Linux-specific section](config.md#platform-specific-configuration) of the [container configuration](config.md).
 The Linux container specification uses various kernel features like namespaces, cgroups, capabilities, LSM, and file system jails to fulfill the spec.
-Additional information is needed for Linux over the [default spec configuration](config.md) in order to configure these various kernel features.
 
 ## Default File Systems
 
diff --git a/config.md b/config.md
index 396ed00e9..1a5333246 100644
--- a/config.md
+++ b/config.md
@@ -165,7 +165,7 @@ _Note: symbolic name for uid and gid, such as uname and gname respectively, are
 "hostname": "mrsdalloway"
 ```
 
-## Platform-specific configuration
+## Platform
 
 * **`os`** (string, required) specifies the operating system family this image must run on. Values for os must be in the list specified by the Go Language document for [`$GOOS`](https://golang.org/doc/install/source#environment).
 * **`arch`** (string, required) specifies the instruction set for which the binaries in the image have been compiled. Values for arch must be in the list specified by the Go Language document for [`$GOARCH`](https://golang.org/doc/install/source#environment).
@@ -179,8 +179,30 @@ _Note: symbolic name for uid and gid, such as uname and gname respectively, are
 }
 ```
 
-Interpretation of the platform section of the JSON file is used to find which platform-specific sections may be available in the document.
-For example, if `os` is set to `linux`, then a JSON object conforming to the [Linux-specific schema](config-linux.md) SHOULD be found at the key `linux` in the `config.json`.
+## Platform-specific configuration
+
+[**`platform.os`**](#platform) is used to lookup further platform-specific configuration.
+
+* **`linux`** (object, optional) [Linux-specific configuration](config-linux.md).
+  This should only be set if **`platform.os`** is `linux`.
+
+### Example (Linux)
+
+```json
+{
+    "platform": {
+        "os": "linux",
+        "arch": "amd64"
+    },
+    "linux": {
+        "namespaces": [
+          {
+            "type": "pid"
+          }
+        ]
+    }
+}
+```
 
 ## Hooks