From a0a051a59c8413eb81a3621df4a84adf3d875e94 Mon Sep 17 00:00:00 2001
From: Jochen Ulrich <jochenulrich@t-online.de>
Date: Thu, 6 Feb 2020 00:34:59 +0100
Subject: Adds missing documentation of timeout property for autotests

Change-Id: I10aa20a8d621030b3d0bea1a465cdbdb9ba6193c
Reviewed-by: Ivan Komissarov <ABBAPOH@gmail.com>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
---
 doc/reference/commands.qdoc                        |  4 ++-
 .../items/convenience/autotestrunner.qdoc          | 34 ++++++++++++++++++++++
 doc/reference/modules/autotest-module.qdoc         | 11 +++++++
 3 files changed, 48 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/reference/commands.qdoc b/doc/reference/commands.qdoc
index d34c20cb7..655412c0a 100644
--- a/doc/reference/commands.qdoc
+++ b/doc/reference/commands.qdoc
@@ -124,9 +124,11 @@
         \li Time limit for the command execution in seconds. If the command does not finish within
             the timeout, it is cancelled. In case of a \c Command, the process is requested to
             terminate. If it does not terminate within three seconds, it is killed. A value below
-            or equal to 0 means no timeout.
+            or equal to 0 means no timeout. \br
+            This property was introduced in Qbs 1.15.
     \endtable
 
+
     \section2 Command Properties
 
     \table
diff --git a/doc/reference/items/convenience/autotestrunner.qdoc b/doc/reference/items/convenience/autotestrunner.qdoc
index e8690ffe2..616d6459f 100644
--- a/doc/reference/items/convenience/autotestrunner.qdoc
+++ b/doc/reference/items/convenience/autotestrunner.qdoc
@@ -69,6 +69,27 @@
             \endcode
     \endlist
 
+
+    \section2 Setting Properties for individual Tests
+    \target autotestrunner-autotest-module
+
+    To control the behavior of individual tests, some properties of the \c AutotestRunner
+    can be overridden by depending on the \l autotest module and setting its properties:
+
+    \code
+    CppApplication {
+        name: "tst_mytest"
+        type: ["application", "autotest"]
+
+        Depends { name: "autotest" }
+
+        autotest.timeout: 60
+
+        // ...
+    }
+    \endcode
+
+
     \section2 Relevant Job Pools
     \target autotestrunner-job-pools
 
@@ -147,3 +168,16 @@
 
     \defaultvalue empty
 */
+
+/*!
+    \qmlproperty int AutotestRunner::timeout
+
+    Time limit for the execution of the individual tests. If a test does not finish within
+    the time limit, the test is cancelled and considered failed. A value below or equal to 0
+    means no timeout.
+    A test can override this by setting the \l{autotest::timeout}{timeout} property
+    of the \l autotest module.
+
+    \defaultvalue -1
+    \since Qbs 1.15
+*/
diff --git a/doc/reference/modules/autotest-module.qdoc b/doc/reference/modules/autotest-module.qdoc
index ddd9e0078..e25be6211 100644
--- a/doc/reference/modules/autotest-module.qdoc
+++ b/doc/reference/modules/autotest-module.qdoc
@@ -67,3 +67,14 @@
     \nodefaultvalue
 */
 
+/*!
+    \qmlproperty int autotest::timeout
+
+    The time limit for the execution of the autotest. If not specified, the
+    \l{AutotestRunner::timeout}{timeout} property of the \l AutotestRunner
+    that invokes the autotest is used.
+
+    \nodefaultvalue
+    \since Qbs 1.15
+*/
+
-- 
cgit v1.2.3