Francois Gouget : testbot: Better document the configuration options.

[Alexandre Julliard]

Module: tools
Branch: master
Commit: 6b2f134e38bcd8926c95f64ca23c894e74e22e12
URL:    http://source.winehq.org/git/tools.git/?a=commit;h=6b2f134e38bcd8926c95f64ca...

Author: Francois Gouget 
Date:   Tue Oct  3 03:26:23 2017 +0200

testbot: Better document the configuration options.

Signed-off-by: Francois Gouget 
Signed-off-by: Alexandre Julliard

---

testbot/lib/WineTestBot/Config.pm | 17 ++++++++++++++++-
 testbot/lib/WineTestBot/Jobs.pm   |  3 ++-
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/testbot/lib/WineTestBot/Config.pm b/testbot/lib/WineTestBot/Config.pm
index 0047770..c5586c7 100644
--- a/testbot/lib/WineTestBot/Config.pm
+++ b/testbot/lib/WineTestBot/Config.pm
@@ -65,18 +65,33 @@ $LogDir = "$::RootDir/var";
 $DataDir = "$::RootDir/var";
 $BinDir = "$::RootDir/bin";

+# See the ScheduleOnHost() documentation in lib/WineTestBot/Jobs.pm
 $MaxRevertingVMs = 1;
 $MaxRevertsWhileRunningVMs = 1;
 $MaxActiveVMs = 2;
 $MaxVMsWhenIdle = undef;
-$SleepAfterRevert = 0;
+
+# How long to wait when connecting to the VM's TestAgent server after a revert
+# (in seconds).
 $WaitForToolsInVM = 30;
+# How long to let the VM settle down after the revert before starting a task on
+# it (in seconds).
+$SleepAfterRevert = 0;

+# How many times to run a test that fails before giving up.
 $MaxTaskTries = 3;

+# How long to let a test suite run before forcibly shutting it down
+# (in seconds).
 $SuiteTimeout = 30 * 60;
+# How long to let a regular test run before forcibly shutting it down
+# (in seconds).
 $SingleTimeout = 2 * 60;
+# How long to let a regular build run before forcibly shutting it down
+# (in seconds).
 $BuildTimeout = 5 * 60;
+# How long to let a full recompilation run before forcibly shutting it down
+# (in seconds).
 $ReconfigTimeout = 45 * 60;

$ProjectName = "Wine";
diff --git a/testbot/lib/WineTestBot/Jobs.pm b/testbot/lib/WineTestBot/Jobs.pm
index 633d9dd..39f9c18 100644
--- a/testbot/lib/WineTestBot/Jobs.pm
+++ b/testbot/lib/WineTestBot/Jobs.pm
@@ -419,7 +419,8 @@ reverting too many VMs at once.
 =item *

Once there are no jobs to run anymore the scheduler can prepare up to
-$MaxVMsWhenIdle VMs (or $MaxActiveVMs if not set) for future jobs.
+$MaxVMsWhenIdle VMs (or $MaxActiveVMs if not set) for future jobs. This can be
+set to 0 to minimize the TestBot resource usage when idle.

=cut