diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2019-03-06 13:07:52 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-03-06 13:07:52 -0800 |
commit | 614409f64464db8022e9dc3bb0b84816ad287781 (patch) | |
tree | df258e444b7ed91a6817e679c3af00c93afb2a2e /API.md | |
parent | 02e2342d20a01c89236b4c2f2867e6acd8eda923 (diff) | |
parent | 8a6758d5fdaba9e6ec58eeb23ee5123762c18b72 (diff) | |
download | podman-614409f64464db8022e9dc3bb0b84816ad287781.tar.gz podman-614409f64464db8022e9dc3bb0b84816ad287781.tar.bz2 podman-614409f64464db8022e9dc3bb0b84816ad287781.zip |
Merge pull request #2534 from jwhonce/wip/remote_wait
Implement podman-remote wait command and container subcommand
Diffstat (limited to 'API.md')
-rwxr-xr-x | API.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -143,7 +143,7 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in [func VolumesPrune() []string, []string](#VolumesPrune) -[func WaitContainer(name: string) int](#WaitContainer) +[func WaitContainer(name: string, interval: int) int](#WaitContainer) [type BuildInfo](#BuildInfo) @@ -1013,10 +1013,10 @@ VolumesPrune removes unused volumes on the host ### <a name="WaitContainer"></a>func WaitContainer <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method WaitContainer(name: [string](https://godoc.org/builtin#string)) [int](https://godoc.org/builtin#int)</div> -WaitContainer takes the name or ID of a container and waits until the container stops. Upon stopping, the return -code of the container is returned. If the container container cannot be found by ID or name, -a [ContainerNotFound](#ContainerNotFound) error is returned. +method WaitContainer(name: [string](https://godoc.org/builtin#string), interval: [int](https://godoc.org/builtin#int)) [int](https://godoc.org/builtin#int)</div> +WaitContainer takes the name or ID of a container and waits the given interval in milliseconds until the container +stops. Upon stopping, the return code of the container is returned. If the container container cannot be found by ID +or name, a [ContainerNotFound](#ContainerNotFound) error is returned. ## Types ### <a name="BuildInfo"></a>type BuildInfo |