Skip to content

Commit eef741b

Browse files
author
Oleksii Tsvietnov
committed
Update readme
1 parent 9fae02c commit eef741b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* [Installation](#installation)
77
* [The installation on top of CentOS Linux base image](#the-installation-on-top-of-centos-linux-base-image)
88
* [The installation on top of Alpine Linux base image](#the-installation-on-top-of-alpine-linux-base-image)
9-
* [How to get started?](#how-to-get-started)
9+
* [How to get started (examples)?](#how-to-get-started)
1010
* [Verbose levels](#verbose-levels)
1111
* [Wait policies](#wait-policies)
1212
* [Integrated functions](#integrated-functions)
@@ -120,7 +120,7 @@ Depending on the value of *RC_WAIT_POLICY* environment variable it makes a decis
120120
The possible values are:
121121

122122
* *wait_all* <br />
123-
stops after exiting all commands and it doesn't matter wether they are synchronous or asynchronous. Just keep in mind, if you need to catch a signal in the main process, it doesn't have to be blocked by some foreground (sync) process. For example, this mode can be helpful if you need to troubleshoot a container (with `wait_any` policy) where some async task fails and the whole container gets stopped by this immediately. In this case, you can change a policy to `wait_all` and run BASH on the foreground like `docker -e RC_WAIT_POLICY=wait_all some-container bash`
123+
stops after exiting all commands and it doesn't matter whether they are synchronous or asynchronous. Just keep in mind, if you need to catch a signal in the main process, it doesn't have to be blocked by some foreground (sync) process. For example, this mode can be helpful if you need to troubleshoot a container (with `wait_any` policy) where some async task fails and the whole container gets stopped by this immediately. In this case, you can change a policy to `wait_all` and run BASH on the foreground like `docker -e RC_WAIT_POLICY=wait_all some-container bash`
124124
* *wait_any* [default] <br />
125125
stops after exiting any of background commands and if there are no foreground commands working at that moment. It makes sense to use this mode if all commands are **asynchronous** (background). For example, if you need to start more than one process in the docker container, they all have to be asynchronous. Then, the main processed will be able to catch signals (for instance, from a docker daemon) and wait for finishing all other async processes.
126126
* *wait_err* <br />

0 commit comments

Comments
 (0)