Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3508 from thaJeztah/tweak_command_descriptions 

Tweak description of some commands
This commit is contained in:
Sebastiaan van Stijn 2022-04-01 19:44:26 +02:00 committed by GitHub
parent c23d45f0c9 b7b923db41
commit dcb13bb110
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cli/command/container/exec.go
View File

@ -45,7 +45,7 @@ func NewExecCommand(dockerCli command.Cli) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "exec [OPTIONS] CONTAINER COMMAND [ARG...]", 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), Args: cli.RequiresMinArgs(2),
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
options.Container = args[0] options.Container = args[0]

2
cli/command/container/run.go
View File

@ -35,7 +35,7 @@ func NewRunCommand(dockerCli command.Cli) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "run [OPTIONS] IMAGE [COMMAND] [ARG...]", 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), Args: cli.RequiresMinArgs(1),
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
copts.Image = args[0] copts.Image = args[0]

2
cli/command/image/pull.go
View File

@ -28,7 +28,7 @@ func NewPullCommand(dockerCli command.Cli) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "pull [OPTIONS] NAME[:TAG|@DIGEST]", 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), Args: cli.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
opts.remote = args[0] opts.remote = args[0]

2
cli/command/image/push.go
View File

@ -29,7 +29,7 @@ func NewPushCommand(dockerCli command.Cli) *cobra.Command {
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "push [OPTIONS] NAME[:TAG]", 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), Args: cli.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
opts.remote = args[0] opts.remote = args[0]

8
contrib/completion/fish/docker.fish
View File

@ -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' complete -c docker -A -f -n '__fish_seen_subcommand_from events' -l until -d 'Stream events until this timestamp'
# exec # 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' -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' -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' complete -c docker -A -f -n '__fish_seen_subcommand_from exec' -s e -l env -d 'Set environment variables'
@ -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.' 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 # 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' -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' -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_images)' -d "Image"
complete -c docker -A -f -n '__fish_seen_subcommand_from pull' -a '(__fish_print_docker_repositories)' -d "Repository" complete -c docker -A -f -n '__fish_seen_subcommand_from pull' -a '(__fish_print_docker_repositories)' -d "Repository"
# push # 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' -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_images)' -d "Image"
complete -c docker -A -f -n '__fish_seen_subcommand_from push' -a '(__fish_print_docker_repositories)' -d "Repository" complete -c docker -A -f -n '__fish_seen_subcommand_from push' -a '(__fish_print_docker_repositories)' -d "Repository"
@ -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" complete -c docker -A -f -n '__fish_seen_subcommand_from rmi' -a '(__fish_print_docker_images)' -d "Image"
# run # 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' -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' -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)' complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s c -l cpu-shares -d 'CPU shares (relative weight)'

8
contrib/completion/zsh/_docker
View File

@ -567,7 +567,7 @@ __docker_container_commands() {
"cp:Copy files/folders between a container and the local filesystem" "cp:Copy files/folders between a container and the local filesystem"
"create:Create a new container" "create:Create a new container"
"diff:Inspect changes on a container's filesystem" "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" "export:Export a container's filesystem as a tar archive"
"inspect:Display detailed information on one or more containers" "inspect:Display detailed information on one or more containers"
"kill:Kill one or more running containers" "kill:Kill one or more running containers"
@ -579,7 +579,7 @@ __docker_container_commands() {
"rename:Rename a container" "rename:Rename a container"
"restart:Restart one or more containers" "restart:Restart one or more containers"
"rm:Remove 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" "start:Start one or more stopped containers"
"stats:Display a live stream of container(s) resource usage statistics" "stats:Display a live stream of container(s) resource usage statistics"
"stop:Stop one or more running containers" "stop:Stop one or more running containers"
@ -974,8 +974,8 @@ __docker_image_commands() {
"load:Load an image from a tar archive or STDIN" "load:Load an image from a tar archive or STDIN"
"ls:List images" "ls:List images"
"prune:Remove unused images" "prune:Remove unused images"
"pull:Pull an image or a repository from a registry" "pull:Download an image from a registry"
"push:Push an image or a repository to a registry" "push:Upload an image to a registry"
"rm:Remove one or more images" "rm:Remove one or more images"
"save:Save one or more images to a tar archive (streamed to STDOUT by default)" "save:Save one or more images to a tar archive (streamed to STDOUT by default)"
"tag:Tag an image into a repository" "tag:Tag an image into a repository"

2
docs/reference/commandline/cli.md
View File

@ -329,7 +329,7 @@ $ docker run --help
Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...] Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...]
Run a command in a new container Create and run a new container from an image
Options: Options:
--add-host value Add a custom host-to-IP mapping (host:ip) (default []) --add-host value Add a custom host-to-IP mapping (host:ip) (default [])

4
docs/reference/commandline/container.md
View File

@ -21,7 +21,7 @@ Commands:
cp Copy files/folders between a container and the local filesystem cp Copy files/folders between a container and the local filesystem
create Create a new container create Create a new container
diff Inspect changes to files or directories on a container's filesystem 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 export Export a container's filesystem as a tar archive
inspect Display detailed information on one or more containers inspect Display detailed information on one or more containers
kill Kill one or more running containers kill Kill one or more running containers
@ -33,7 +33,7 @@ Commands:
rename Rename a container rename Rename a container
restart Restart one or more containers restart Restart one or more containers
rm Remove 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 start Start one or more stopped containers
stats Display a live stream of container(s) resource usage statistics stats Display a live stream of container(s) resource usage statistics
stop Stop one or more running containers stop Stop one or more running containers

2
docs/reference/commandline/exec.md
View File

@ -9,7 +9,7 @@ keywords: "command, container, run, execute"
```markdown ```markdown
Usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...] Usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...]
Run a command in a running container Execute a command in a running container
Options: Options:
-d, --detach Detached mode: run command in the background -d, --detach Detached mode: run command in the background

4
docs/reference/commandline/image.md
View File

@ -23,8 +23,8 @@ Commands:
load Load an image from a tar archive or STDIN load Load an image from a tar archive or STDIN
ls List images ls List images
prune Remove unused images prune Remove unused images
pull Pull an image or a repository from a registry pull Download an image from a registry
push Push an image or a repository to a registry push Upload an image to a registry
rm Remove one or more images rm Remove one or more images
save Save one or more images to a tar archive (streamed to STDOUT by default) 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 tag Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE

8
docs/reference/commandline/index.md
View File

@ -53,7 +53,7 @@ read the [`dockerd`](dockerd.md) reference page.
| [create](create.md) | Create a new container | | [create](create.md) | Create a new container |
| [diff](diff.md) | Inspect changes on a container's filesystem | | [diff](diff.md) | Inspect changes on a container's filesystem |
| [events](events.md) | Get real time events from the server | | [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 | | [export](export.md) | Export a container's filesystem as a tar archive |
| [kill](kill.md) | Kill a running container | | [kill](kill.md) | Kill a running container |
| [logs](logs.md) | Fetch the logs of a container | | [logs](logs.md) | Fetch the logs of a container |
@ -63,7 +63,7 @@ read the [`dockerd`](dockerd.md) reference page.
| [rename](rename.md) | Rename a container | | [rename](rename.md) | Rename a container |
| [restart](restart.md) | Restart a running container | | [restart](restart.md) | Restart a running container |
| [rm](rm.md) | Remove one or more containers | | [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 | | [start](start.md) | Start one or more stopped containers |
| [stats](stats.md) | Display a live stream of container(s) resource usage statistics | | [stats](stats.md) | Display a live stream of container(s) resource usage statistics |
| [stop](stop.md) | Stop a running container | | [stop](stop.md) | Stop a running container |
@ -78,8 +78,8 @@ read the [`dockerd`](dockerd.md) reference page.
|:--------------------|:------------------------------------------------------------------------| |:--------------------|:------------------------------------------------------------------------|
| [login](login.md) | Register or log in to a Docker registry | | [login](login.md) | Register or log in to a Docker registry |
| [logout](logout.md) | Log out from 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 | | [pull](pull.md) | Download an image from a registry |
| [push](push.md) | Push an image or a repository to a Docker registry | | [push](push.md) | Upload an image to a registry |
| [search](search.md) | Search Docker Hub for images | | [search](search.md) | Search Docker Hub for images |
### Network and connectivity commands ### Network and connectivity commands

2
docs/reference/commandline/pull.md
View File

@ -9,7 +9,7 @@ keywords: "pull, image, hub, docker"
```markdown ```markdown
Usage: docker pull [OPTIONS] NAME[:TAG|@DIGEST] Usage: docker pull [OPTIONS] NAME[:TAG|@DIGEST]
Pull an image or a repository from a registry Download an image from a registry
Options: Options:
-a, --all-tags Download all tagged images in the repository -a, --all-tags Download all tagged images in the repository

2
docs/reference/commandline/push.md
View File

@ -9,7 +9,7 @@ keywords: "share, push, image"
```markdown ```markdown
Usage: docker push [OPTIONS] NAME[:TAG] Usage: docker push [OPTIONS] NAME[:TAG]
Push an image or a repository to a registry Upload an image to a registry
Options: Options:
-a, --all-tags Push all tags of an image to the repository -a, --all-tags Push all tags of an image to the repository

2
docs/reference/commandline/run.md
View File

@ -9,7 +9,7 @@ keywords: "run, command, container"
```markdown ```markdown
Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...] Usage: docker run [OPTIONS] IMAGE [COMMAND] [ARG...]
Run a command in a new container Create and run a new container from an image
Options: Options:
--add-host value Add a custom host-to-IP mapping (host:ip) (default []) --add-host value Add a custom host-to-IP mapping (host:ip) (default [])

2
man/docker-run.1.md
View File

@ -1,7 +1,7 @@
% "DOCKER" "1" "JUNE 2014" "Docker Community" "Docker User Manuals" % "DOCKER" "1" "JUNE 2014" "Docker Community" "Docker User Manuals"
# NAME # NAME
docker-run - Run a command in a new container docker-run - Create and run a new container from an image
# SYNOPSIS # SYNOPSIS
**docker run** **docker run**