Skip to content

Commit

Permalink
docs(ios): remove TERMINATE from the suggested lifecycle actions
Browse files Browse the repository at this point in the history
  • Loading branch information
Malinskiy committed Jul 15, 2023
1 parent 844101c commit 9807044
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
11 changes: 9 additions & 2 deletions docs/docs/ios/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,10 +261,17 @@ If you specify custom ones then your values will be placed as a lower priority p

### Test run lifecycle
Marathon provides two lifecycle hooks: `onPrepare` and `onDispose`.
For each you can specify one of the `TERMINATE` (terminate simulator), `SHUTDOWN` (shutdown simulator) and `ERASE` (erase simulator).
For each you can specify one of the following actions: `SHUTDOWN` (shutdown simulator), `ERASE` (erase simulator) and `TERMINATE` (terminate simulator).

These can be useful during provisioning of workers, e.g. you might want to erase the existing simulators before using them

:::warning

If you specify `TERMINATE` marathon will `kill -SIGKILL` the simulators. This usually results in simulators unable to boot with
black screen as well as a number of zombie processes and can only be resolved by erasing the state. In most cases `SHUTDOWN` is the recommended action.

:::

:::tip

If you specify `ERASE` then marathon will first shut down the simulator since it's impossible to erase it otherwise
Expand All @@ -277,7 +284,7 @@ lifecycle:
onPrepare:
- ERASE
onDispose:
- TERMINATE
- SHUTDOWN
```

:::tip
Expand Down
11 changes: 9 additions & 2 deletions docs/versioned_docs/version-0.8.0/ios/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,10 +261,17 @@ If you specify custom ones then your values will be placed as a lower priority p

### Test run lifecycle
Marathon provides two lifecycle hooks: `onPrepare` and `onDispose`.
For each you can specify one of the `TERMINATE` (terminate simulator), `SHUTDOWN` (shutdown simulator) and `ERASE` (erase simulator).
For each you can specify one of the following actions: `SHUTDOWN` (shutdown simulator), `ERASE` (erase simulator) and `TERMINATE` (terminate simulator).

These can be useful during provisioning of workers, e.g. you might want to erase the existing simulators before using them

:::warning

If you specify `TERMINATE` marathon will `kill -SIGKILL` the simulators. This usually results in simulators unable to boot with
black screen as well as a number of zombie processes and can only be resolved by erasing the state. In most cases `SHUTDOWN` is the recommended action.

:::

:::tip

If you specify `ERASE` then marathon will first shut down the simulator since it's impossible to erase it otherwise
Expand All @@ -277,7 +284,7 @@ lifecycle:
onPrepare:
- ERASE
onDispose:
- TERMINATE
- SHUTDOWN
```

:::tip
Expand Down

0 comments on commit 9807044

Please sign in to comment.