summaryrefslogtreecommitdiffstats
path: root/src/testlib/doc/src/qttestlib-manual.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/testlib/doc/src/qttestlib-manual.qdoc')
-rw-r--r--src/testlib/doc/src/qttestlib-manual.qdoc97
1 files changed, 18 insertions, 79 deletions
diff --git a/src/testlib/doc/src/qttestlib-manual.qdoc b/src/testlib/doc/src/qttestlib-manual.qdoc
index d0f6296480..d775ae5b76 100644
--- a/src/testlib/doc/src/qttestlib-manual.qdoc
+++ b/src/testlib/doc/src/qttestlib-manual.qdoc
@@ -1,7 +1,8 @@
/****************************************************************************
**
-** Copyright (C) 2015 The Qt Company Ltd.
-** Contact: http://www.qt.io/licensing/
+** Copyright (C) 2016 The Qt Company Ltd.
+** Copyright (C) 2016 Intel Corporation.
+** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
@@ -11,8 +12,8 @@
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
-** and conditions see http://www.qt.io/terms-conditions. For further
-** information use the contact form at http://www.qt.io/contact-us.
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
@@ -20,7 +21,7 @@
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
-** will be met: http://www.gnu.org/copyleft/fdl.html.
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
@@ -189,6 +190,8 @@
\li \c -csv \br
Outputs results as comma-separated values (CSV). This mode is only suitable for
benchmarks, since it suppresses normal pass/fail messages.
+ \li \c -teamcity \br
+ Outputs results in TeamCity format.
\endlist
The first version of the \c -o option may be repeated in order to log
@@ -196,8 +199,8 @@
option can log test results to standard output.
If the first version of the \c -o option is used, neither the second version
- of the \c -o option nor the \c -txt, \c -xml, \c -lightxml or \c -xunitxml
- options should be used.
+ of the \c -o option nor the \c -txt, \c -xml, \c -lightxml, \c -teamcity
+ or \c -xunitxml options should be used.
If neither version of the \c -o option is used, test results will be logged to
standard output. If no format option is used, test results will be logged in
@@ -346,82 +349,18 @@
counters can be obtained by running any benchmark executable with the
option \c -perfcounterlist.
- Note that using the performance counter may require enabling access to non-privileged applications.
-
- \note Depending on the device configuration, tick counters on the
- Windows CE platform may not be as fine-grained, compared to other platforms.
- Devices that do not support high-resolution timers default to
- one-millisecond granularity.
-
- See \l {Chapter 5: Writing a Benchmark}{Writing a Benchmark} in the Qt Test
- Tutorial for more benchmarking examples.
-
- \section1 Using Qt Test Remotely on Windows CE
-
- The \c cetest convenience application enables you to launch an
- application remotely on a Windows CE device or emulator.
-
- It needs to be executed after the unit test has been successfully compiled.
-
- Prior to launching, the following files are copied to the device:
-
\list
- \li all Qt libraries the project links to
- \li \l {QtRemote}{QtRemote.dll}
- \li the c runtime library specified during installation
- \li all files specified in the \c .pro file following the \l DEPLOYMENT rules.
- \endlist
-
- \section2 Syntax
- The syntax to execute an autotest takes the following simple form:
-
- \snippet code/doc_src_qtestlib.qdoc 6
-
- \section2 Options
- \c cetest provides the same options as those for unit-testing on non cross-compiled
- platforms. See \l {Qt Test Command Line Arguments} {Command Line Arguments} for
- more information.
-
- The following commands are also included:
-
+ \li \b Notes:
\list
- \li \c -debug \br
- Compiles the test version in debug mode.
- \li \c -release \br
- Compiles the test version in release mode.
- \li \c -libpath \e path \br
- Copies Qt libraries to the specified path.
- \li \c -qt-delete \br
- Deletes Qt libraries after execution.
- \li \c -project-delete \br
- Deletes project files after execution.
- \li \c -delete \br
- Deletes project and Qt libraries after execution.
- \li \c -conf \br
- Specifies a qt.conf file to be deployed to remote directory.
+ \li Using the performance counter may require enabling access to non-privileged
+ applications.
+ \li Devices that do not support high-resolution timers default to
+ one-millisecond granularity.
+ \endlist
\endlist
- \note \c{debug} is the default build option.
-
- \section2 QtRemote
- \c QtRemote is a small library which is built after Qt Test. It allows the host
- system to create a process on a remote device and waits until its execution has
- been finished.
-
- \section2 Requirements
- \c cetest uses Microsoft ActiveSync to establish a remote connection between the
- host computer and the device. Thus header files and libraries are needed to compile
- cetest and QtRemote successfully.
-
- Prior to \l{Installing Qt for Windows CE}{installation} of Qt, you need to set your
- \c INCLUDE and \c LIB environment variables properly.
-
- A default installation of Windows Mobile 5 for Pocket PC can be obtained by:
-
- \snippet code/doc_src_qtestlib.qdoc 7
-
- Note that Qt will remember the path, so you do not need to set it again
- after switching the environments for cross-compilation.
+ See \l {Chapter 5: Writing a Benchmark}{Writing a Benchmark} in the Qt Test
+ Tutorial for more benchmarking examples.
\section1 3rd Party Code