From ac22b2bf52ee618939e294707446e06e3461dc99 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Tue, 29 Mar 2022 23:54:35 +0200 Subject: [PATCH 1/3] tweak description of "docker exec" command Signed-off-by: Sebastiaan van Stijn --- cli/command/container/exec.go | 2 +- contrib/completion/fish/docker.fish | 2 +- contrib/completion/zsh/_docker | 2 +- docs/reference/commandline/container.md | 2 +- docs/reference/commandline/exec.md | 2 +- docs/reference/commandline/index.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/cli/command/container/exec.go b/cli/command/container/exec.go index 3e78d8e506..9259e53d84 100644 --- a/cli/command/container/exec.go +++ b/cli/command/container/exec.go @@ -45,7 +45,7 @@ func NewExecCommand(dockerCli command.Cli) *cobra.Command { cmd := &cobra.Command{ Use: "exec [OPTIONS] CONTAINER COMMAND [ARG...]", - Short: "Run a command in a running container", + Short: "Execute a command in a running container", Args: cli.RequiresMinArgs(2), RunE: func(cmd *cobra.Command, args []string) error { options.Container = args[0] diff --git a/contrib/completion/fish/docker.fish b/contrib/completion/fish/docker.fish index eb3ddcc676..639f5cabd4 100644 --- a/contrib/completion/fish/docker.fish +++ b/contrib/completion/fish/docker.fish @@ -287,7 +287,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from events' -l since -d 'Sh complete -c docker -A -f -n '__fish_seen_subcommand_from events' -l until -d 'Stream events until this timestamp' # exec -complete -c docker -f -n '__fish_docker_no_subcommand' -a exec -d 'Run a command in a running container' +complete -c docker -f -n '__fish_docker_no_subcommand' -a exec -d 'Execute a command in a running container' complete -c docker -A -f -n '__fish_seen_subcommand_from exec' -s d -l detach -d 'Detached mode: run command in the background' complete -c docker -A -f -n '__fish_seen_subcommand_from exec' -l detach-keys -d 'Override the key sequence for detaching a container' complete -c docker -A -f -n '__fish_seen_subcommand_from exec' -s e -l env -d 'Set environment variables' diff --git a/contrib/completion/zsh/_docker b/contrib/completion/zsh/_docker index 67381a1fe4..932bc5f502 100644 --- a/contrib/completion/zsh/_docker +++ b/contrib/completion/zsh/_docker @@ -567,7 +567,7 @@ __docker_container_commands() { "cp:Copy files/folders between a container and the local filesystem" "create:Create a new container" "diff:Inspect changes on a container's filesystem" - "exec:Run a command in a running container" + "exec:Execute a command in a running container" "export:Export a container's filesystem as a tar archive" "inspect:Display detailed information on one or more containers" "kill:Kill one or more running containers" diff --git a/docs/reference/commandline/container.md b/docs/reference/commandline/container.md index 5425e0f6e7..abec5b98bd 100644 --- a/docs/reference/commandline/container.md +++ b/docs/reference/commandline/container.md @@ -21,7 +21,7 @@ Commands: cp Copy files/folders between a container and the local filesystem create Create a new container diff Inspect changes to files or directories on a container's filesystem - exec Run a command in a running container + exec Execute a command in a running container export Export a container's filesystem as a tar archive inspect Display detailed information on one or more containers kill Kill one or more running containers diff --git a/docs/reference/commandline/exec.md b/docs/reference/commandline/exec.md index 1786618025..d43b42ffef 100644 --- a/docs/reference/commandline/exec.md +++ b/docs/reference/commandline/exec.md @@ -9,7 +9,7 @@ keywords: "command, container, run, execute" ```markdown Usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...] -Run a command in a running container +Execute a command in a running container Options: -d, --detach Detached mode: run command in the background diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 51bce7a458..1c9ea31111 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -53,7 +53,7 @@ read the [`dockerd`](dockerd.md) reference page. | [create](create.md) | Create a new container | | [diff](diff.md) | Inspect changes on a container's filesystem | | [events](events.md) | Get real time events from the server | -| [exec](exec.md) | Run a command in a running container | +| [exec](exec.md) | Execute a command in a running container | | [export](export.md) | Export a container's filesystem as a tar archive | | [kill](kill.md) | Kill a running container | | [logs](logs.md) | Fetch the logs of a container | From 6e6652b7020076aca62e37b97b737fb6337a2172 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Tue, 29 Mar 2022 23:58:36 +0200 Subject: [PATCH 2/3] 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** From b7b923db4166c8a8794020aa9a6b5e0af3e32233 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 30 Mar 2022 00:11:09 +0200 Subject: [PATCH 3/3] tweak description of "docker push" and "docker pull" commands Signed-off-by: Sebastiaan van Stijn --- cli/command/image/pull.go | 2 +- cli/command/image/push.go | 2 +- contrib/completion/fish/docker.fish | 4 ++-- contrib/completion/zsh/_docker | 4 ++-- docs/reference/commandline/image.md | 4 ++-- docs/reference/commandline/index.md | 4 ++-- docs/reference/commandline/pull.md | 2 +- docs/reference/commandline/push.md | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/cli/command/image/pull.go b/cli/command/image/pull.go index cf15fca706..242ad4a19c 100644 --- a/cli/command/image/pull.go +++ b/cli/command/image/pull.go @@ -28,7 +28,7 @@ func NewPullCommand(dockerCli command.Cli) *cobra.Command { cmd := &cobra.Command{ Use: "pull [OPTIONS] NAME[:TAG|@DIGEST]", - Short: "Pull an image or a repository from a registry", + Short: "Download an image from a registry", Args: cli.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.remote = args[0] diff --git a/cli/command/image/push.go b/cli/command/image/push.go index e4db32ab8e..771a99592e 100644 --- a/cli/command/image/push.go +++ b/cli/command/image/push.go @@ -29,7 +29,7 @@ func NewPushCommand(dockerCli command.Cli) *cobra.Command { cmd := &cobra.Command{ Use: "push [OPTIONS] NAME[:TAG]", - Short: "Push an image or a repository to a registry", + Short: "Upload an image to a registry", Args: cli.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.remote = args[0] diff --git a/contrib/completion/fish/docker.fish b/contrib/completion/fish/docker.fish index d752d56850..dd2c751ec1 100644 --- a/contrib/completion/fish/docker.fish +++ b/contrib/completion/fish/docker.fish @@ -414,14 +414,14 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from ps' -s s -l size -d 'Di complete -c docker -A -f -n '__fish_seen_subcommand_from ps' -l since -d 'Show only containers created since Id or Name, include non-running ones.' # pull -complete -c docker -f -n '__fish_docker_no_subcommand' -a pull -d 'Pull an image or a repository from a Docker registry server' +complete -c docker -f -n '__fish_docker_no_subcommand' -a pull -d 'Download an image from a registry' complete -c docker -A -f -n '__fish_seen_subcommand_from pull' -s a -l all-tags -d 'Download all tagged images in the repository' complete -c docker -A -f -n '__fish_seen_subcommand_from pull' -l help -d 'Print usage' complete -c docker -A -f -n '__fish_seen_subcommand_from pull' -a '(__fish_print_docker_images)' -d "Image" complete -c docker -A -f -n '__fish_seen_subcommand_from pull' -a '(__fish_print_docker_repositories)' -d "Repository" # push -complete -c docker -f -n '__fish_docker_no_subcommand' -a push -d 'Push an image or a repository to a Docker registry server' +complete -c docker -f -n '__fish_docker_no_subcommand' -a push -d 'Upload an image to a registry' complete -c docker -A -f -n '__fish_seen_subcommand_from push' -l help -d 'Print usage' complete -c docker -A -f -n '__fish_seen_subcommand_from push' -a '(__fish_print_docker_images)' -d "Image" complete -c docker -A -f -n '__fish_seen_subcommand_from push' -a '(__fish_print_docker_repositories)' -d "Repository" diff --git a/contrib/completion/zsh/_docker b/contrib/completion/zsh/_docker index 4a258d7869..5cb131523e 100644 --- a/contrib/completion/zsh/_docker +++ b/contrib/completion/zsh/_docker @@ -974,8 +974,8 @@ __docker_image_commands() { "load:Load an image from a tar archive or STDIN" "ls:List images" "prune:Remove unused images" - "pull:Pull an image or a repository from a registry" - "push:Push an image or a repository to a registry" + "pull:Download an image from a registry" + "push:Upload an image to a registry" "rm:Remove one or more images" "save:Save one or more images to a tar archive (streamed to STDOUT by default)" "tag:Tag an image into a repository" diff --git a/docs/reference/commandline/image.md b/docs/reference/commandline/image.md index 4ca4e9e18b..4fbb782163 100644 --- a/docs/reference/commandline/image.md +++ b/docs/reference/commandline/image.md @@ -23,8 +23,8 @@ Commands: load Load an image from a tar archive or STDIN ls List images prune Remove unused images - pull Pull an image or a repository from a registry - push Push an image or a repository to a registry + pull Download an image from a registry + push Upload an image to a registry rm Remove one or more images save Save one or more images to a tar archive (streamed to STDOUT by default) tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE diff --git a/docs/reference/commandline/index.md b/docs/reference/commandline/index.md index 740126ad70..cc0c73d9d4 100644 --- a/docs/reference/commandline/index.md +++ b/docs/reference/commandline/index.md @@ -78,8 +78,8 @@ read the [`dockerd`](dockerd.md) reference page. |:--------------------|:------------------------------------------------------------------------| | [login](login.md) | Register or log in to a Docker registry | | [logout](logout.md) | Log out from a Docker registry | -| [pull](pull.md) | Pull an image or a repository from a Docker registry | -| [push](push.md) | Push an image or a repository to a Docker registry | +| [pull](pull.md) | Download an image from a registry | +| [push](push.md) | Upload an image to a registry | | [search](search.md) | Search Docker Hub for images | ### Network and connectivity commands diff --git a/docs/reference/commandline/pull.md b/docs/reference/commandline/pull.md index faa90ab681..874e05dfbf 100644 --- a/docs/reference/commandline/pull.md +++ b/docs/reference/commandline/pull.md @@ -9,7 +9,7 @@ keywords: "pull, image, hub, docker" ```markdown Usage: docker pull [OPTIONS] NAME[:TAG|@DIGEST] -Pull an image or a repository from a registry +Download an image from a registry Options: -a, --all-tags Download all tagged images in the repository diff --git a/docs/reference/commandline/push.md b/docs/reference/commandline/push.md index f6ac39f844..5cbb704e18 100644 --- a/docs/reference/commandline/push.md +++ b/docs/reference/commandline/push.md @@ -9,7 +9,7 @@ keywords: "share, push, image" ```markdown Usage: docker push [OPTIONS] NAME[:TAG] -Push an image or a repository to a registry +Upload an image to a registry Options: -a, --all-tags Push all tags of an image to the repository