Skip to content

Commit 43ac1e3

Browse files
terevglours
authored andcommitted
Update wait-timeout flag usage to include the unit
Signed-off-by: Trevor Foster <[email protected]>
1 parent 5561a77 commit 43ac1e3

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

cmd/compose/up.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ import (
2626

2727
"github.com/compose-spec/compose-go/v2/types"
2828
"github.com/docker/cli/cli/command"
29-
"github.com/docker/compose/v2/cmd/formatter"
3029
xprogress "github.com/moby/buildkit/util/progress/progressui"
3130
"github.com/spf13/cobra"
3231

32+
"github.com/docker/compose/v2/cmd/formatter"
3333
"github.com/docker/compose/v2/pkg/api"
3434
ui "github.com/docker/compose/v2/pkg/progress"
3535
"github.com/docker/compose/v2/pkg/utils"
@@ -167,7 +167,7 @@ func upCommand(p *ProjectOptions, dockerCli command.Cli, backend api.Service) *c
167167
flags.StringArrayVar(&up.noAttach, "no-attach", []string{}, "Do not attach (stream logs) to the specified services")
168168
flags.BoolVar(&up.attachDependencies, "attach-dependencies", false, "Automatically attach to log output of dependent services")
169169
flags.BoolVar(&up.wait, "wait", false, "Wait for services to be running|healthy. Implies detached mode.")
170-
flags.IntVar(&up.waitTimeout, "wait-timeout", 0, "Maximum duration to wait for the project to be running|healthy")
170+
flags.IntVar(&up.waitTimeout, "wait-timeout", 0, "Maximum duration in seconds to wait for the project to be running|healthy")
171171
flags.BoolVarP(&up.watch, "watch", "w", false, "Watch source code and rebuild/refresh containers when files are updated.")
172172
flags.BoolVar(&up.navigationMenu, "menu", false, "Enable interactive shortcuts when running attached. Incompatible with --detach. Can also be enable/disable by setting COMPOSE_MENU environment var.")
173173

docs/reference/compose_up.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ If the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the contai
5151
| `-t`, `--timeout` | `int` | `0` | Use this timeout in seconds for container shutdown when attached or when containers are already running |
5252
| `--timestamps` | `bool` | | Show timestamps |
5353
| `--wait` | `bool` | | Wait for services to be running\|healthy. Implies detached mode. |
54-
| `--wait-timeout` | `int` | `0` | Maximum duration to wait for the project to be running\|healthy |
54+
| `--wait-timeout` | `int` | `0` | Maximum duration in seconds to wait for the project to be running\|healthy |
5555
| `-w`, `--watch` | `bool` | | Watch source code and rebuild/refresh containers when files are updated. |
5656

5757

docs/reference/docker_compose_up.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,8 @@ options:
289289
- option: wait-timeout
290290
value_type: int
291291
default_value: "0"
292-
description: Maximum duration to wait for the project to be running|healthy
292+
description: |
293+
Maximum duration in seconds to wait for the project to be running|healthy
293294
deprecated: false
294295
hidden: false
295296
experimental: false

0 commit comments

Comments
 (0)