From 56ba8c3929802fb00c4803452024e23cdb54cc99 Mon Sep 17 00:00:00 2001
From: Roman Melnikov
Date: Wed, 20 Dec 2023 13:54:27 +0100
Subject: [Chore] Add missing documentation for timeout options

Problem: README misses documentation for 'confirmTimeout' and
'activationTimeout'.

Solution: Mention them in README.
---
 README.md  | 10 ++++++++++
 src/cli.rs |  2 +-
 2 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a5beaf8..4525001 100644
--- a/README.md
+++ b/README.md
@@ -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/).
diff --git a/src/cli.rs b/src/cli.rs
index b25aed2..8ac6f59 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -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)
-- 
cgit v1.2.3