From d77bcd1691e1028bd4259b2ff54d8ccbacb47c83 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 16 Oct 2016 19:22:42 -0700 Subject: [PATCH] Improve example for env vars in API docs This was added in e41de3e6318ad4cb30eabab9bec60f9fb9d7a76b, but can be a bit confusing due to the "outer" brackets being for JSON, and the "inner" brackets to indicate optional values. During review of that change, this alternative format was suggested. Updating the example to use the format that was discussed during review :) Signed-off-by: Sebastiaan van Stijn Upstream-commit: 441c9411e369f5146783c46d7a9413917dacaebe Component: engine --- components/engine/docs/reference/api/docker_remote_api_v1.18.md | 2 +- components/engine/docs/reference/api/docker_remote_api_v1.19.md | 2 +- components/engine/docs/reference/api/docker_remote_api_v1.20.md | 2 +- components/engine/docs/reference/api/docker_remote_api_v1.21.md | 2 +- components/engine/docs/reference/api/docker_remote_api_v1.22.md | 2 +- components/engine/docs/reference/api/docker_remote_api_v1.23.md | 2 +- components/engine/docs/reference/api/docker_remote_api_v1.24.md | 2 +- components/engine/docs/reference/api/docker_remote_api_v1.25.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.18.md b/components/engine/docs/reference/api/docker_remote_api_v1.18.md index 07bed5652c..855851ae63 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.18.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.18.md @@ -210,7 +210,7 @@ Create a container - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **OpenStdin** - Boolean value, opens `stdin`, - **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects. -- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` +- **Env** - A list of environment variables in the form of `["VAR=value", ...]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entry point for the container as a string or an array diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.19.md b/components/engine/docs/reference/api/docker_remote_api_v1.19.md index 8370727eb6..8bf4963e14 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.19.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.19.md @@ -215,7 +215,7 @@ Create a container - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **OpenStdin** - Boolean value, opens `stdin`, - **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects. -- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` +- **Env** - A list of environment variables in the form of `["VAR=value", ...]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entry point for the container as a string or an array diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.20.md b/components/engine/docs/reference/api/docker_remote_api_v1.20.md index 0468ba4c2b..293031897b 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.20.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.20.md @@ -217,7 +217,7 @@ Create a container - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **OpenStdin** - Boolean value, opens `stdin`, - **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects. -- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` +- **Env** - A list of environment variables in the form of `["VAR=value", ...]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entry point for the container as a string or an array diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.21.md b/components/engine/docs/reference/api/docker_remote_api_v1.21.md index d6c5aecb68..9101697f5e 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.21.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.21.md @@ -226,7 +226,7 @@ Create a container - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **OpenStdin** - Boolean value, opens `stdin`, - **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects. -- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` +- **Env** - A list of environment variables in the form of `["VAR=value", ...]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entry point for the container as a string or an array diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.22.md b/components/engine/docs/reference/api/docker_remote_api_v1.22.md index 649d593e84..177ff8cd47 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.22.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.22.md @@ -329,7 +329,7 @@ Create a container - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **OpenStdin** - Boolean value, opens `stdin`, - **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects. -- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` +- **Env** - A list of environment variables in the form of `["VAR=value", ...]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entry point for the container as a string or an array diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.23.md b/components/engine/docs/reference/api/docker_remote_api_v1.23.md index bdb8d19fc6..7d8466ce43 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.23.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.23.md @@ -352,7 +352,7 @@ Create a container - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **OpenStdin** - Boolean value, opens `stdin`, - **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects. -- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` +- **Env** - A list of environment variables in the form of `["VAR=value", ...]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entry point for the container as a string or an array diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.24.md b/components/engine/docs/reference/api/docker_remote_api_v1.24.md index ac34f58e9b..9face204b2 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.24.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.24.md @@ -369,7 +369,7 @@ Create a container - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **OpenStdin** - Boolean value, opens `stdin`, - **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects. -- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` +- **Env** - A list of environment variables in the form of `["VAR=value", ...]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entry point for the container as a string or an array diff --git a/components/engine/docs/reference/api/docker_remote_api_v1.25.md b/components/engine/docs/reference/api/docker_remote_api_v1.25.md index bb775527d7..0e2005277d 100644 --- a/components/engine/docs/reference/api/docker_remote_api_v1.25.md +++ b/components/engine/docs/reference/api/docker_remote_api_v1.25.md @@ -374,7 +374,7 @@ Create a container - **Tty** - Boolean value, Attach standard streams to a `tty`, including `stdin` if it is not closed. - **OpenStdin** - Boolean value, opens `stdin`, - **StdinOnce** - Boolean value, close `stdin` after the 1 attached client disconnects. -- **Env** - A list of environment variables in the form of `["VAR=value"[,"VAR2=value2"]]` +- **Env** - A list of environment variables in the form of `["VAR=value", ...]` - **Labels** - Adds a map of labels to a container. To specify a map: `{"key":"value"[,"key2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entry point for the container as a string or an array