summaryrefslogtreecommitdiffstats
path: root/src/testlib/doc
diff options
context:
space:
mode:
authorGiuseppe D'Angelo <giuseppe.dangelo@kdab.com>2020-12-03 00:10:39 +0100
committerGiuseppe D'Angelo <giuseppe.dangelo@kdab.com>2020-12-04 00:17:46 +0100
commit89def082c6db80e877e2a6a33db41b67f94cdf46 (patch)
tree1b0c6acddad5c594ba0638d7daff21f5a43a4a73 /src/testlib/doc
parenta7610a0cf79c576b098999822c5070a078e51326 (diff)
QTestLib: allow for non-zero values in env variables
The usual behavior for env variables is that any nonzero value means "enable", so do the same for a couple of QTestLib env vars. While at it: document them. Change-Id: I854285df5d7af5be771f9d6532ddec5d8a6f8987 Pick-to: 6.0 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/testlib/doc')
-rw-r--r--src/testlib/doc/src/qttestlib-manual.qdoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/testlib/doc/src/qttestlib-manual.qdoc b/src/testlib/doc/src/qttestlib-manual.qdoc
index 87ac565278..73c010888f 100644
--- a/src/testlib/doc/src/qttestlib-manual.qdoc
+++ b/src/testlib/doc/src/qttestlib-manual.qdoc
@@ -362,6 +362,20 @@
Outputs the possible command line arguments and gives some useful help.
\endlist
+ \section1 Qt Test Environment Variables
+
+ You can set certain environment variables in order to affect
+ the execution of an autotest:
+
+ \list
+ \li \c QTEST_DISABLE_CORE_DUMP \br
+ Setting this variable to a non-zero value will disable the generation
+ of a core dump file.
+ \li \c QTEST_DISABLE_STACK_DUMP \br
+ Setting this variable to a non-zero value will prevent Qt Test from
+ printing a stacktrace in case an autotest times out or crashes.
+ \endlist
+
\section1 Creating a Benchmark
To create a benchmark, follow the instructions for creating a test and then add a