summaryrefslogtreecommitdiffstats
path: root/Help/command/ctest_memcheck.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-05-07 20:10:20 (GMT)
committerBrad King <brad.king@kitware.com>2015-05-07 20:10:20 (GMT)
commit695d6f62d31efc8c979e80713dc550a1b1054e00 (patch)
treecb86f349efe3f77432cfcc08cbb5dfdbae220be1 /Help/command/ctest_memcheck.rst
parentf8716c8b4466dd464853a5f9484ac151689c1d0c (diff)
downloadCMake-695d6f62d31efc8c979e80713dc550a1b1054e00.zip
CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.gz
CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.bz2
Help: Revise ctest_* command documentation (#15559)
Revise documentation for the major dashboard client step ``ctest_*`` commands. Modernize the documentation formatting. Add some missing options.
Diffstat (limited to 'Help/command/ctest_memcheck.rst')
-rw-r--r--Help/command/ctest_memcheck.rst42
1 files changed, 19 insertions, 23 deletions
diff --git a/Help/command/ctest_memcheck.rst b/Help/command/ctest_memcheck.rst
index 56a2490..2800511 100644
--- a/Help/command/ctest_memcheck.rst
+++ b/Help/command/ctest_memcheck.rst
@@ -1,32 +1,28 @@
ctest_memcheck
--------------
-Run tests with a dynamic analysis tool.
+Perform the :ref:`CTest MemCheck Step` as a :ref:`Dashboard Client`.
::
- ctest_memcheck([BUILD build_dir] [RETURN_VALUE res] [APPEND]
- [START start number] [END end number]
- [STRIDE stride number] [EXCLUDE exclude regex ]
- [INCLUDE include regex]
- [EXCLUDE_LABEL exclude regex]
- [INCLUDE_LABEL label regex]
- [PARALLEL_LEVEL level] )
+ ctest_memcheck([BUILD <build-dir>] [APPEND]
+ [START <start-number>]
+ [END <end-number>]
+ [STRIDE <stride-number>]
+ [EXCLUDE <exclude-regex>]
+ [INCLUDE <include-regex>]
+ [EXCLUDE_LABEL <label-exclude-regex>]
+ [INCLUDE_LABEL <label-include-regex>]
+ [PARALLEL_LEVEL <level>]
+ [SCHEDULE_RANDOM <ON|OFF>]
+ [STOP_TIME <time-of-day>]
+ [RETURN_VALUE <result-var>]
+ [QUIET]
+ )
-Tests the given build directory and stores results in MemCheck.xml.
-The second argument is a variable that will hold value. Optionally,
-you can specify the starting test number START, the ending test number
-END, the number of tests to skip between each test STRIDE, a regular
-expression for tests to run INCLUDE, or a regular expression for tests
-not to run EXCLUDE. EXCLUDE_LABEL and INCLUDE_LABEL are regular
-expressions for tests to be included or excluded by the test property
-LABEL. PARALLEL_LEVEL should be set to a positive number representing
-the number of tests to be run in parallel.
-The APPEND option marks results for append to those previously
-submitted to a dashboard server since the last ctest_start. Append
-semantics are defined by the dashboard server in use.
+Run tests with a dynamic analysis tool and store results in
+``MemCheck.xml`` for submission with the :command:`ctest_submit`
+command.
-The QUIET option suppresses any CTest-specific non-error messages
-that would have otherwise been printed to the console. Output from
-the underlying tests are not affected.
+The options are the same as those for the :command:`ctest_test` command.