Skip to content

Commit 3a454c4

Browse files
committed
run: rename use-docker-socket to use-api-socket
Signed-off-by: Stephen Day <stephen.day@docker.com>
1 parent 8799c1e commit 3a454c4

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed

cli/command/container/create.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ func NewCreateCommand(dockerCli command.Cli) *cobra.Command {
7878
flags.StringVar(&options.name, "name", "", "Assign a name to the container")
7979
flags.StringVar(&options.pull, "pull", PullImageMissing, `Pull image before creating ("`+PullImageAlways+`", "|`+PullImageMissing+`", "`+PullImageNever+`")`)
8080
flags.BoolVarP(&options.quiet, "quiet", "q", false, "Suppress the pull output")
81-
flags.BoolVarP(&options.useDockerSocket, "use-docker-socket", "", false, "Bind mount docker socket and required auth")
81+
flags.BoolVarP(&options.useDockerSocket, "use-api-socket", "", false, "Bind mount Docker API socket and required auth")
8282

8383
// Add an explicit help that doesn't have a `-h` to prevent the conflict
8484
// with hostname
@@ -256,7 +256,7 @@ func createContainer(ctx context.Context, dockerCli command.Cli, containerCfg *c
256256

257257
socket := dockerCli.DockerEndpoint().Host
258258
if !strings.HasPrefix(socket, "unix://") {
259-
return "", fmt.Errorf("flag --use-docker-socket can only be used with unix sockets: docker endpoint %s incompatible", socket)
259+
return "", fmt.Errorf("flag --use-api-socket can only be used with unix sockets: docker endpoint %s incompatible", socket)
260260
}
261261
socket = strings.TrimPrefix(socket, "unix://") // should we confirm absolute path?
262262

cli/command/container/run.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ func NewRunCommand(dockerCli command.Cli) *cobra.Command {
6060
flags.StringVar(&options.detachKeys, "detach-keys", "", "Override the key sequence for detaching a container")
6161
flags.StringVar(&options.pull, "pull", PullImageMissing, `Pull image before running ("`+PullImageAlways+`", "`+PullImageMissing+`", "`+PullImageNever+`")`)
6262
flags.BoolVarP(&options.quiet, "quiet", "q", false, "Suppress the pull output")
63-
flags.BoolVarP(&options.createOptions.useDockerSocket, "use-docker-socket", "", false, "Bind mount docker socket and required auth")
63+
flags.BoolVarP(&options.createOptions.useAPISocket, "use-api-socket", "", false, "Bind mount Docker API socket and required auth")
6464

6565
// Add an explicit help that doesn't have a `-h` to prevent the conflict
6666
// with hostname

docs/reference/commandline/container_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Create a new container
104104
| `--tmpfs` | `list` | | Mount a tmpfs directory |
105105
| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY |
106106
| `--ulimit` | `ulimit` | | Ulimit options |
107-
| `--use-docker-socket` | `bool` | | Bind mount docker socket and required auth |
107+
| `--use-docker-socket` | `bool` | | Bind mount Docker API socket and required auth |
108108
| `-u`, `--user` | `string` | | Username or UID (format: <name\|uid>[:<group\|gid>]) |
109109
| `--userns` | `string` | | User namespace to use |
110110
| `--uts` | `string` | | UTS namespace to use |

docs/reference/commandline/container_run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Create and run a new container from an image
107107
| [`--tmpfs`](#tmpfs) | `list` | | Mount a tmpfs directory |
108108
| [`-t`](#tty), [`--tty`](#tty) | `bool` | | Allocate a pseudo-TTY |
109109
| [`--ulimit`](#ulimit) | `ulimit` | | Ulimit options |
110-
| `--use-docker-socket` | `bool` | | Bind mount docker socket and required auth |
110+
| `--use-api-socket ` | `bool` | | Bind mount Docker API socket and required auth |
111111
| `-u`, `--user` | `string` | | Username or UID (format: <name\|uid>[:<group\|gid>]) |
112112
| [`--userns`](#userns) | `string` | | User namespace to use |
113113
| [`--uts`](#uts) | `string` | | UTS namespace to use |

docs/reference/commandline/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Create a new container
104104
| `--tmpfs` | `list` | | Mount a tmpfs directory |
105105
| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY |
106106
| `--ulimit` | `ulimit` | | Ulimit options |
107-
| `--use-docker-socket` | `bool` | | Bind mount docker socket and required auth |
107+
| `--use-docker-socket` | `bool` | | Bind mount Docker API socket and required auth |
108108
| `-u`, `--user` | `string` | | Username or UID (format: <name\|uid>[:<group\|gid>]) |
109109
| `--userns` | `string` | | User namespace to use |
110110
| `--uts` | `string` | | UTS namespace to use |

docs/reference/commandline/run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Create and run a new container from an image
107107
| `--tmpfs` | `list` | | Mount a tmpfs directory |
108108
| `-t`, `--tty` | `bool` | | Allocate a pseudo-TTY |
109109
| `--ulimit` | `ulimit` | | Ulimit options |
110-
| `--use-docker-socket` | `bool` | | Bind mount docker socket and required auth |
110+
| `--use-docker-socket` | `bool` | | Bind mount Docker API socket and required auth |
111111
| `-u`, `--user` | `string` | | Username or UID (format: <name\|uid>[:<group\|gid>]) |
112112
| `--userns` | `string` | | User namespace to use |
113113
| `--uts` | `string` | | UTS namespace to use |

0 commit comments

Comments
 (0)