From 98e261ba3258354e7c40053aa32004a246cd6333 Mon Sep 17 00:00:00 2001 From: Suleiman Dibirov Date: Mon, 19 Aug 2024 11:14:05 +0300 Subject: [PATCH] docs(wait): Fix wait command description Signed-off-by: Suleiman Dibirov --- cmd/compose/wait.go | 2 +- docs/reference/compose.md | 2 +- docs/reference/compose_wait.md | 2 +- docs/reference/docker_compose_wait.yaml | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/cmd/compose/wait.go b/cmd/compose/wait.go index 88c939140..105f87878 100644 --- a/cmd/compose/wait.go +++ b/cmd/compose/wait.go @@ -43,7 +43,7 @@ func waitCommand(p *ProjectOptions, dockerCli command.Cli, backend api.Service) var err error cmd := &cobra.Command{ 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), RunE: Adapt(func(ctx context.Context, services []string) error { opts.services = services diff --git a/docs/reference/compose.md b/docs/reference/compose.md index 26a216e02..1ca135231 100644 --- a/docs/reference/compose.md +++ b/docs/reference/compose.md @@ -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 | | [`up`](compose_up.md) | Create and start containers | | [`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 | diff --git a/docs/reference/compose_wait.md b/docs/reference/compose_wait.md index cc62d5967..59474c9b5 100644 --- a/docs/reference/compose_wait.md +++ b/docs/reference/compose_wait.md @@ -1,7 +1,7 @@ # docker compose wait -Block until the first service container stops +Block until containers of all (or specified) services stop. ### Options diff --git a/docs/reference/docker_compose_wait.yaml b/docs/reference/docker_compose_wait.yaml index 87f69059c..5d8f3013c 100644 --- a/docs/reference/docker_compose_wait.yaml +++ b/docs/reference/docker_compose_wait.yaml @@ -1,6 +1,6 @@ command: docker compose wait -short: Block until the first service container stops -long: Block until the first service container stops +short: Block until containers of all (or specified) services stop. +long: Block until containers of all (or specified) services stop. usage: docker compose wait SERVICE [SERVICE...] [OPTIONS] pname: docker compose plink: docker_compose.yaml