From 6e6652b7020076aca62e37b97b737fb6337a2172 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Tue, 29 Mar 2022 23:58:36 +0200 Subject: [PATCH] tweak description of "docker run" command Signed-off-by: Sebastiaan van Stijn --- cli/command/container/run.go | 2 +- contrib/completion/fish/docker.fish | 2 +- contrib/completion/zsh/_docker | 2 +- docs/reference/commandline/cli.md | 2 +- docs/reference/commandline/container.md | 2 +- docs/reference/commandline/index.md | 2 +- docs/reference/commandline/run.md | 2 +- man/docker-run.1.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/cli/command/container/run.go b/cli/command/container/run.go index cf49779f78..38785129b8 100644 --- a/cli/command/container/run.go +++ b/cli/command/container/run.go @@ -35,7 +35,7 @@ func NewRunCommand(dockerCli command.Cli) *cobra.Command { cmd := &cobra.Command{ Use: "run [OPTIONS] IMAGE [COMMAND] [ARG...]", - Short: "Run a command in a new container", + Short: "Create and run a new container from an image", Args: cli.RequiresMinArgs(1), RunE: func(cmd *cobra.Command, args []string) error { copts.Image = args[0] diff --git a/contrib/completion/fish/docker.fish b/contrib/completion/fish/docker.fish index 639f5cabd4..d752d56850 100644 --- a/contrib/completion/fish/docker.fish +++ b/contrib/completion/fish/docker.fish @@ -452,7 +452,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from rmi' -l no-prune -d 'Do complete -c docker -A -f -n '__fish_seen_subcommand_from rmi' -a '(__fish_print_docker_images)' -d "Image" # run -complete -c docker -f -n '__fish_docker_no_subcommand' -a run -d 'Run a command in a new container' +complete -c docker -f -n '__fish_docker_no_subcommand' -a run -d 'Create and run a new container from an image' complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s a -l attach -d 'Attach to STDIN, STDOUT or STDERR.' complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l add-host -d 'Add a custom host-to-IP mapping (host:ip)' complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s c -l cpu-shares -d 'CPU shares (relative weight)' diff --git a/contrib/completion/zsh/_docker b/contrib/completion/zsh/_docker index 932bc5f502..4a258d7869 100644 --- a/contrib/completion/zsh/_docker +++ b/contrib/completion/zsh/_docker @@ -579,7 +579,7 @@ __docker_container_commands() { "rename:Rename a container" "restart:Restart one or more containers" "rm:Remove one or more containers" - "run:Run a command in a new container" + "run:Create and run a new container from an image" "start:Start one or more stopped containers" "stats:Display a live stream of container(s) resource usage statistics" "stop:Stop one or more running containers" diff --git a/docs/reference/commandline/cli.md b/docs/reference/commandline/cli.md index cfa6496079..fe3a303204 100644 --- a/docs/reference/commandline/cli.md +++ b/docs/reference/commandline/cli.md @@ -329,7 +329,7 @@ $ docker run --help Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...] -Run a command in a new container +Create and run a new container from an image Options: --add-host value Add a custom host-to-IP mapping (host:ip) (default []) diff --git a/docs/reference/commandline/container.md b/docs/reference/commandline/container.md index abec5b98bd..ec5166a2bc 100644 --- a/docs/reference/commandline/container.md +++ b/docs/reference/commandline/container.md @@ -33,7 +33,7 @@ Commands: rename Rename a container restart Restart one or more containers rm Remove one or more containers - run Run a command in a new container + run Create and run a new container from an image start Start one or more stopped containers stats Display a live stream of container(s) resource usage statistics stop Stop one or more running containers diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 1c9ea31111..740126ad70 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -63,7 +63,7 @@ read the [`dockerd`](dockerd.md) reference page. | [rename](rename.md) | Rename a container | | [restart](restart.md) | Restart a running container | | [rm](rm.md) | Remove one or more containers | -| [run](run.md) | Run a command in a new container | +| [run](run.md) | Create and run a new container from an image | | [start](start.md) | Start one or more stopped containers | | [stats](stats.md) | Display a live stream of container(s) resource usage statistics | | [stop](stop.md) | Stop a running container | diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index 878a39509f..b45cd7e485 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -9,7 +9,7 @@ keywords: "run, command, container" ```markdown Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...] -Run a command in a new container +Create and run a new container from an image Options: --add-host value Add a custom host-to-IP mapping (host:ip) (default []) diff --git a/man/docker-run.1.md b/man/docker-run.1.md index 1acf9a943a..d345a89907 100644 --- a/man/docker-run.1.md +++ b/man/docker-run.1.md @@ -1,7 +1,7 @@ % "DOCKER" "1" "JUNE 2014" "Docker Community" "Docker User Manuals" # NAME -docker-run - Run a command in a new container +docker-run - Create and run a new container from an image # SYNOPSIS **docker run**