From 6bbe5722aa5af242052c15b422d6969472e59219 Mon Sep 17 00:00:00 2001 From: Yong Tang Date: Fri, 15 Apr 2016 11:08:15 -0700 Subject: [PATCH] Fix incorrect docs in remote API for the option of `SecurityOpt` This fix tries to fix the issue in remote API docs for v1.15 (Docker 1.3.x) and v1.16 (Docker 1.4.x) where `SecurityOpts` was used but the actual field should be `SecurityOpt`. This `SecurityOpt` field is verified through the source code in v1.3.0 and v1.4.0: https://github.com/docker/docker/blob/v1.3.0/runconfig/config.go#L35 https://github.com/docker/docker/blob/v1.4.0/runconfig/hostconfig.go#L98 Signed-off-by: Yong Tang (cherry picked from commit f3f981624bc9329740e9a1c52e71471ca38d8171) Signed-off-by: Sebastiaan van Stijn --- docs/reference/api/docker_remote_api_v1.15.md | 4 ++-- docs/reference/api/docker_remote_api_v1.16.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/api/docker_remote_api_v1.15.md b/docs/reference/api/docker_remote_api_v1.15.md index f6a860a4f9..5625eee56e 100644 --- a/docs/reference/api/docker_remote_api_v1.15.md +++ b/docs/reference/api/docker_remote_api_v1.15.md @@ -151,7 +151,7 @@ Create a container "ExposedPorts": { "22/tcp": {} }, - "SecurityOpts": [], + "SecurityOpt": [], "HostConfig": { "Binds": ["/tmp:/tmp"], "Links": ["redis3:redis"], @@ -212,7 +212,7 @@ Json Parameters: container - **ExposedPorts** - An object mapping ports to an empty object in the form of: `"ExposedPorts": { "/: {}" }` -- **SecurityOpts**: A list of string values to customize labels for MLS +- **SecurityOpt**: A list of string values to customize labels for MLS systems, such as SELinux. - **HostConfig** - **Binds** – A list of volume bindings for this container. Each volume diff --git a/docs/reference/api/docker_remote_api_v1.16.md b/docs/reference/api/docker_remote_api_v1.16.md index 630da70144..ef9bca0e83 100644 --- a/docs/reference/api/docker_remote_api_v1.16.md +++ b/docs/reference/api/docker_remote_api_v1.16.md @@ -151,7 +151,7 @@ Create a container "ExposedPorts": { "22/tcp": {} }, - "SecurityOpts": [], + "SecurityOpt": [], "HostConfig": { "Binds": ["/tmp:/tmp"], "Links": ["redis3:redis"], @@ -212,7 +212,7 @@ Json Parameters: container - **ExposedPorts** - An object mapping ports to an empty object in the form of: `"ExposedPorts": { "/: {}" }` -- **SecurityOpts**: A list of string values to customize labels for MLS +- **SecurityOpt**: A list of string values to customize labels for MLS systems, such as SELinux. - **HostConfig** - **Binds** – A list of volume bindings for this container. Each volume