1berry/docker-compose
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(wait): Fix wait command description

Browse Source 
Signed-off-by: Suleiman Dibirov <idsulik@gmail.com>
This commit is contained in:
Suleiman Dibirov 2024-08-19 11:14:05 +03:00 committed by Nicolas De loof
parent 11c7a25ae9
commit 98e261ba32
4 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/compose/wait.go
View File

@ -43,7 +43,7 @@ func waitCommand(p *ProjectOptions, dockerCli command.Cli, backend api.Service)
var err error var err error
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "wait SERVICE [SERVICE...] [OPTIONS]", Use: "wait SERVICE [SERVICE...] [OPTIONS]",
Short: "Block until the first service container stops", Short: "Block until containers of all (or specified) services stop.",
Args: cli.RequiresMinArgs(1), Args: cli.RequiresMinArgs(1),
RunE: Adapt(func(ctx context.Context, services []string) error { RunE: Adapt(func(ctx context.Context, services []string) error {
opts.services = services opts.services = services

2
docs/reference/compose.md
View File

@ -178,7 +178,7 @@ Dry Run mode works with almost all commands. You cannot use Dry Run mode with a
| [`unpause`](compose_unpause.md) | Unpause services | | [`unpause`](compose_unpause.md) | Unpause services |
| [`up`](compose_up.md) | Create and start containers | | [`up`](compose_up.md) | Create and start containers |
| [`version`](compose_version.md) | Show the Docker Compose version information | | [`version`](compose_version.md) | Show the Docker Compose version information |
| [`wait`](compose_wait.md) | Block until the first service container stops | | [`wait`](compose_wait.md) | Block until containers of all (or specified) services stop. |
| [`watch`](compose_watch.md) | Watch build context for service and rebuild/refresh containers when files are updated | | [`watch`](compose_watch.md) | Watch build context for service and rebuild/refresh containers when files are updated |

2
docs/reference/compose_wait.md
View File

@ -1,7 +1,7 @@
# docker compose wait # docker compose wait
<!---MARKER_GEN_START--> <!---MARKER_GEN_START-->
Block until the first service container stops Block until containers of all (or specified) services stop.
### Options ### Options

4
docs/reference/docker_compose_wait.yaml
View File

@ -1,6 +1,6 @@
command: docker compose wait command: docker compose wait
short: Block until the first service container stops short: Block until containers of all (or specified) services stop.
long: Block until the first service container stops long: Block until containers of all (or specified) services stop.
usage: docker compose wait SERVICE [SERVICE...] [OPTIONS] usage: docker compose wait SERVICE [SERVICE...] [OPTIONS]
pname: docker compose pname: docker compose
plink: docker_compose.yaml plink: docker_compose.yaml