diff options
author | Roman Melnikov | 2023-12-20 13:54:27 +0100 |
---|---|---|
committer | Roman Melnikov | 2023-12-20 13:55:53 +0100 |
commit | 56ba8c3929802fb00c4803452024e23cdb54cc99 (patch) | |
tree | eb733f30e74d98906ea84887834b6dc5af4259b3 | |
parent | 915327515f5fd1b7719c06e2f1eb304ee0bdd803 (diff) |
[Chore] Add missing documentation for timeout options
Problem: README misses documentation for 'confirmTimeout' and
'activationTimeout'.
Solution: Mention them in README.
-rw-r--r-- | README.md | 10 | ||||
-rw-r--r-- | src/cli.rs | 2 |
2 files changed, 11 insertions, 1 deletions
@@ -218,9 +218,19 @@ This is a set of options that can be put in any of the above definitions, with t # Will also fetch all external dependencies from the target system's substituters. # This default to `false` remoteBuild = true; + + # Timeout for profile activation. + # This defaults to 240 seconds. + activationTimeout = 600; + + # Timeout for profile activation confirmation. + # This defaults to 30 seconds. + confirmTimeout = 60; } ``` +Some of these options can be provided during `deploy` invocation to override default values or values provided in your flake, see `deploy --help`. + ## About Serokell deploy-rs is maintained and funded with ❤️ by [Serokell](https://serokell.io/). @@ -85,7 +85,7 @@ pub struct Opts { /// How long activation should wait for confirmation (if using magic-rollback) #[clap(long)] confirm_timeout: Option<u16>, - /// How long we should wait for profile activation (if using magic-rollback) + /// How long we should wait for profile activation #[clap(long)] activation_timeout: Option<u16>, /// Where to store temporary files (only used by magic-rollback) |