OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	04/04/2023 07:10:48 PM	rwxr-xr-x
📄 ccmake.1.html	44.19 KB	04/04/2023 07:05:08 PM	rw-r--r--
📄 cmake-buildsystem.7.html	161.14 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-commands.7.html	21.66 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-compile-features.7.html	46.17 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-configure-log.7.html	35.93 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-developer.7.html	60.56 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-env-variables.7.html	15.36 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-file-api.7.html	174.79 KB	04/04/2023 07:05:10 PM	rw-r--r--
📄 cmake-generator-expressions.7.html	229.68 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-generators.7.html	16.07 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-gui.1.html	27.62 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-language.7.html	67.9 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-modules.7.html	37.63 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-packages.7.html	84.94 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-policies.7.html	48.41 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-presets.7.html	122.21 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-properties.7.html	80.47 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-qt.7.html	47.92 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-server.7.html	5.39 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-toolchains.7.html	92.74 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-variables.7.html	105.71 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake.1.html	170.8 KB	04/04/2023 07:05:13 PM	rw-r--r--
📄 cpack-generators.7.html	7.54 KB	04/04/2023 07:05:13 PM	rw-r--r--
📄 cpack.1.html	39.49 KB	04/04/2023 07:05:13 PM	rw-r--r--
📄 ctest.1.html	230.72 KB	04/04/2023 07:05:13 PM	rw-r--r--

Editing: ctest.1.html

<!DOCTYPE html>

<title>ctest(1) &mdash; CMake 3.26.3 Documentation</title>

</head><body>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="cpack.1.html" title="cpack(1)"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="cmake.1.html" title="cmake(1)"
 accesskey="P">previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-this"><a href="">ctest(1)</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="ctest-1">
<h1><a class="toc-backref" href="#id15" role="doc-backlink">ctest(1)</a><a class="headerlink" href="#ctest-1" title="Permalink to this heading">¶</a></h1>
<nav class="contents" id="contents">
Contents
<ul class="simple">
<li><a class="reference internal" href="#ctest-1" id="id15">ctest(1)</a>
<ul>
<li><a class="reference internal" href="#synopsis" id="id16">Synopsis</a></li>
<li><a class="reference internal" href="#description" id="id17">Description</a></li>
<li><a class="reference internal" href="#run-tests" id="id18">Run Tests</a></li>
<li><a class="reference internal" href="#view-help" id="id19">View Help</a></li>
<li><a class="reference internal" href="#label-matching" id="id20">Label Matching</a></li>
<li><a class="reference internal" href="#label-and-subproject-summary" id="id21">Label and Subproject Summary</a></li>
<li><a class="reference internal" href="#build-and-test-mode" id="id22">Build and Test Mode</a></li>
<li><a class="reference internal" href="#dashboard-client" id="id23">Dashboard Client</a>
<ul>
<li><a class="reference internal" href="#dashboard-client-steps" id="id24">Dashboard Client Steps</a></li>
<li><a class="reference internal" href="#dashboard-client-modes" id="id25">Dashboard Client Modes</a></li>
<li><a class="reference internal" href="#dashboard-client-via-ctest-command-line" id="id26">Dashboard Client via CTest Command-Line</a></li>
<li><a class="reference internal" href="#dashboard-client-via-ctest-script" id="id27">Dashboard Client via CTest Script</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dashboard-client-configuration" id="id28">Dashboard Client Configuration</a>
<ul>
<li><a class="reference internal" href="#ctest-start-step" id="id29">CTest Start Step</a></li>
<li><a class="reference internal" href="#ctest-update-step" id="id30">CTest Update Step</a></li>
<li><a class="reference internal" href="#ctest-configure-step" id="id31">CTest Configure Step</a></li>
<li><a class="reference internal" href="#ctest-build-step" id="id32">CTest Build Step</a></li>
<li><a class="reference internal" href="#ctest-test-step" id="id33">CTest Test Step</a></li>
<li><a class="reference internal" href="#ctest-coverage-step" id="id34">CTest Coverage Step</a></li>
<li><a class="reference internal" href="#ctest-memcheck-step" id="id35">CTest MemCheck Step</a></li>
<li><a class="reference internal" href="#ctest-submit-step" id="id36">CTest Submit Step</a></li>
</ul>
</li>
<li><a class="reference internal" href="#show-as-json-object-model" id="id37">Show as JSON Object Model</a></li>
<li><a class="reference internal" href="#resource-allocation" id="id38">Resource Allocation</a>
<ul>
<li><a class="reference internal" href="#resource-specification-file" id="id39">Resource Specification File</a></li>
<li><a class="reference internal" href="#resource-groups-property" id="id40"><code class="docutils literal notranslate">RESOURCE_GROUPS</code> Property</a></li>
<li><a class="reference internal" href="#environment-variables" id="id41">Environment Variables</a></li>
</ul>
</li>
<li><a class="reference internal" href="#see-also" id="id42">See Also</a></li>
</ul>
</li>
</ul>
</nav>
<section id="synopsis">
<h2><a class="toc-backref" href="#id16" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
<pre class="literal-block"><a class="reference internal" href="#run-tests">Run Tests</a>
 ctest [&lt;options&gt;]

<a class="reference internal" href="#build-and-test-mode">Build and Test Mode</a>
 ctest --build-and-test &lt;path-to-source&gt; &lt;path-to-build&gt;
 --build-generator &lt;generator&gt; [&lt;options&gt;...]
 [--build-options &lt;opts&gt;...]
 [--test-command &lt;command&gt; [&lt;args&gt;...]]

<a class="reference internal" href="#dashboard-client">Dashboard Client</a>
 ctest -D &lt;dashboard&gt; [-- &lt;dashboard-options&gt;...]
 ctest -M &lt;model&gt; -T &lt;action&gt; [-- &lt;dashboard-options&gt;...]
 ctest -S &lt;script&gt; [-- &lt;dashboard-options&gt;...]
 ctest -SP &lt;script&gt; [-- &lt;dashboard-options&gt;...]

<a class="reference internal" href="#view-help">View Help</a>
 ctest --help[-&lt;topic&gt;]</pre>
</section>
<section id="description">
<h2><a class="toc-backref" href="#id17" role="doc-backlink">Description</a><a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
The ctest executable is the CMake test driver program.
CMake-generated build trees created for projects that use the
<a class="reference internal" href="../command/enable_testing.html#command:enable_testing" title="enable_testing"><code class="xref cmake cmake-command docutils literal notranslate">enable_testing()</code></a> and <a class="reference internal" href="../command/add_test.html#command:add_test" title="add_test"><code class="xref cmake cmake-command docutils literal notranslate">add_test()</code></a> commands have testing support.
This program will run the tests and report results.
</section>
<section id="run-tests">
<h2><a class="toc-backref" href="#id18" role="doc-backlink">Run Tests</a><a class="headerlink" href="#run-tests" title="Permalink to this heading">¶</a></h2>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-preset">
--preset &lt;preset&gt;, --preset=&lt;preset&gt;<a class="headerlink" href="#cmdoption-ctest-preset" title="Permalink to this definition">¶</a></dt>
<dd>Use a test preset to specify test options. The project binary directory
is inferred from the <code class="docutils literal notranslate">configurePreset</code> key. The current working directory
must contain CMake preset files.
See <a class="reference internal" href="cmake-presets.7.html#manual:cmake-presets(7)" title="cmake-presets(7)"><code class="xref cmake cmake-manual docutils literal notranslate">preset</code></a> for more details.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-list-presets">
--list-presets<a class="headerlink" href="#cmdoption-ctest-list-presets" title="Permalink to this definition">¶</a></dt>
<dd>Lists the available test presets. The current working directory must contain
CMake preset files.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-C">
-C &lt;cfg&gt;, --build-config &lt;cfg&gt;<a class="headerlink" href="#cmdoption-ctest-C" title="Permalink to this definition">¶</a></dt>
<dd>Choose configuration to test.
Some CMake-generated build trees can have multiple build
configurations in the same tree. This option can be used to specify
which one should be tested. Example configurations are <code class="docutils literal notranslate">Debug</code> and
<code class="docutils literal notranslate">Release</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-progress">
--progress<a class="headerlink" href="#cmdoption-ctest-progress" title="Permalink to this definition">¶</a></dt>
<dd>Enable short progress output from tests.
When the output of ctest is being sent directly to a terminal, the
progress through the set of tests is reported by updating the same line
rather than printing start and end messages for each test on new lines.
This can significantly reduce the verbosity of the test output.
Test completion messages are still output on their own line for failed
tests and the final test summary will also still be logged.
This option can also be enabled by setting the environment variable
<a class="reference internal" href="../envvar/CTEST_PROGRESS_OUTPUT.html#envvar:CTEST_PROGRESS_OUTPUT" title="CTEST_PROGRESS_OUTPUT"><code class="xref cmake cmake-envvar docutils literal notranslate">CTEST_PROGRESS_OUTPUT</code></a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-V">
-V, --verbose<a class="headerlink" href="#cmdoption-ctest-V" title="Permalink to this definition">¶</a></dt>
<dd>Enable verbose output from tests.
Test output is normally suppressed and only summary information is
displayed. This option will show all test output.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-VV">
-VV, --extra-verbose<a class="headerlink" href="#cmdoption-ctest-VV" title="Permalink to this definition">¶</a></dt>
<dd>Enable more verbose output from tests.
Test output is normally suppressed and only summary information is
displayed. This option will show even more test output.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-debug">
--debug<a class="headerlink" href="#cmdoption-ctest-debug" title="Permalink to this definition">¶</a></dt>
<dd>Displaying more verbose internals of CTest.
This feature will result in a large number of output that is mostly
useful for debugging dashboard problems.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-output-on-failure">
--output-on-failure<a class="headerlink" href="#cmdoption-ctest-output-on-failure" title="Permalink to this definition">¶</a></dt>
<dd>Output anything outputted by the test program if the test should fail.
This option can also be enabled by setting the
<a class="reference internal" href="../envvar/CTEST_OUTPUT_ON_FAILURE.html#envvar:CTEST_OUTPUT_ON_FAILURE" title="CTEST_OUTPUT_ON_FAILURE"><code class="xref cmake cmake-envvar docutils literal notranslate">CTEST_OUTPUT_ON_FAILURE</code></a> environment variable
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-stop-on-failure">
--stop-on-failure<a class="headerlink" href="#cmdoption-ctest-stop-on-failure" title="Permalink to this definition">¶</a></dt>
<dd>Stop running the tests when the first failure happens.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-F">
-F<a class="headerlink" href="#cmdoption-ctest-F" title="Permalink to this definition">¶</a></dt>
<dd>Enable failover.
This option allows CTest to resume a test set execution that was
previously interrupted. If no interruption occurred, the <code class="docutils literal notranslate">-F</code> option
will have no effect.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-j">
-j &lt;jobs&gt;, --parallel &lt;jobs&gt;<a class="headerlink" href="#cmdoption-ctest-j" title="Permalink to this definition">¶</a></dt>
<dd>Run the tests in parallel using the given number of jobs.
This option tells CTest to run the tests in parallel using given
number of jobs. This option can also be set by setting the
<a class="reference internal" href="../envvar/CTEST_PARALLEL_LEVEL.html#envvar:CTEST_PARALLEL_LEVEL" title="CTEST_PARALLEL_LEVEL"><code class="xref cmake cmake-envvar docutils literal notranslate">CTEST_PARALLEL_LEVEL</code></a> environment variable.
This option can be used with the <a class="reference internal" href="../prop_test/PROCESSORS.html#prop_test:PROCESSORS" title="PROCESSORS"><code class="xref cmake cmake-prop_test docutils literal notranslate">PROCESSORS</code></a> test property.
See <a class="reference internal" href="#label-and-subproject-summary">Label and Subproject Summary</a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-resource-spec-file">
--resource-spec-file &lt;file&gt;<a class="headerlink" href="#cmdoption-ctest-resource-spec-file" title="Permalink to this definition">¶</a></dt>
<dd>Run CTest with <a class="reference internal" href="#ctest-resource-allocation">resource allocation</a> enabled,
using the
<a class="reference internal" href="#ctest-resource-specification-file">resource specification file</a>
specified in <code class="docutils literal notranslate">&lt;file&gt;</code>.
When ctest is run as a <a class="reference internal" href="#dashboard-client">Dashboard Client</a> this sets the
<code class="docutils literal notranslate">ResourceSpecFile</code> option of the <a class="reference internal" href="#ctest-test-step">CTest Test Step</a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-test-load">
--test-load &lt;level&gt;<a class="headerlink" href="#cmdoption-ctest-test-load" title="Permalink to this definition">¶</a></dt>
<dd>While running tests in parallel (e.g. with <a class="reference internal" href="#cmdoption-ctest-j"><code class="xref std std-option docutils literal notranslate">-j</code></a>), try
not to start tests when they may cause the CPU load to pass above a given
threshold.
When ctest is run as a <a class="reference internal" href="#dashboard-client">Dashboard Client</a> this sets the
<code class="docutils literal notranslate">TestLoad</code> option of the <a class="reference internal" href="#ctest-test-step">CTest Test Step</a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-Q">
-Q, --quiet<a class="headerlink" href="#cmdoption-ctest-Q" title="Permalink to this definition">¶</a></dt>
<dd>Make CTest quiet.
This option will suppress all the output. The output log file will
still be generated if the <a class="reference internal" href="#cmdoption-ctest-O"><code class="xref std std-option docutils literal notranslate">--output-log</code></a> is
specified. Options such as <a class="reference internal" href="#cmdoption-ctest-V"><code class="xref std std-option docutils literal notranslate">--verbose</code></a>,
<a class="reference internal" href="#cmdoption-ctest-VV"><code class="xref std std-option docutils literal notranslate">--extra-verbose</code></a>, and
<a class="reference internal" href="#cmdoption-ctest-debug"><code class="xref std std-option docutils literal notranslate">--debug</code></a> are ignored
if <code class="docutils literal notranslate">--quiet</code> is specified.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-O">
-O &lt;file&gt;, --output-log &lt;file&gt;<a class="headerlink" href="#cmdoption-ctest-O" title="Permalink to this definition">¶</a></dt>
<dd>Output to log file.
This option tells CTest to write all its output to a <code class="docutils literal notranslate">&lt;file&gt;</code> log file.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-output-junit">
--output-junit &lt;file&gt;<a class="headerlink" href="#cmdoption-ctest-output-junit" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.21.
</div>
Write test results in JUnit format.
This option tells CTest to write test results to <code class="docutils literal notranslate">&lt;file&gt;</code> in JUnit XML
format. If <code class="docutils literal notranslate">&lt;file&gt;</code> already exists, it will be overwritten. If using the
<a class="reference internal" href="#cmdoption-ctest-S"><code class="xref std std-option docutils literal notranslate">-S</code></a> option to run a dashboard script, use the
<code class="docutils literal notranslate">OUTPUT_JUNIT</code> keyword with the <a class="reference internal" href="../command/ctest_test.html#command:ctest_test" title="ctest_test"><code class="xref cmake cmake-command docutils literal notranslate">ctest_test()</code></a> command instead.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-N">
-N, --show-only[=&lt;format&gt;]<a class="headerlink" href="#cmdoption-ctest-N" title="Permalink to this definition">¶</a></dt>
<dd>Disable actual execution of tests.
This option tells CTest to list the tests that would be run but not
actually run them. Useful in conjunction with the <a class="reference internal" href="#cmdoption-ctest-R"><code class="xref std std-option docutils literal notranslate">-R</code></a>
and <a class="reference internal" href="#cmdoption-ctest-E"><code class="xref std std-option docutils literal notranslate">-E</code></a> options.
<div class="versionadded">
New in version 3.14: The <code class="docutils literal notranslate">--show-only</code> option accepts a <code class="docutils literal notranslate">&lt;format&gt;</code> value.
</div>
<code class="docutils literal notranslate">&lt;format&gt;</code> can be one of the following values.
<blockquote>
<div><dl class="simple">
<dt><code class="docutils literal notranslate">human</code></dt><dd>Human-friendly output. This is not guaranteed to be stable.
This is the default.
</dd>
<dt><code class="docutils literal notranslate">json-v1</code></dt><dd>Dump the test information in JSON format.
See <a class="reference internal" href="#show-as-json-object-model">Show as JSON Object Model</a>.
</dd>
</dl>
</div></blockquote>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-L">
-L &lt;regex&gt;, --label-regex &lt;regex&gt;<a class="headerlink" href="#cmdoption-ctest-L" title="Permalink to this definition">¶</a></dt>
<dd>Run tests with labels matching regular expression as described under
<a class="reference internal" href="../command/string.html#regex-specification">string(REGEX)</a>.
This option tells CTest to run only the tests whose labels match the
given regular expression. When more than one <code class="docutils literal notranslate">-L</code> option is given,
a test will only be run if each regular expression matches at least one
of the test's labels (i.e. the multiple <code class="docutils literal notranslate">-L</code> labels form an <code class="docutils literal notranslate">AND</code>
relationship). See <a class="reference internal" href="#label-matching">Label Matching</a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-R">
-R &lt;regex&gt;, --tests-regex &lt;regex&gt;<a class="headerlink" href="#cmdoption-ctest-R" title="Permalink to this definition">¶</a></dt>
<dd>Run tests matching regular expression.
This option tells CTest to run only the tests whose names match the
given regular expression.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-E">
-E &lt;regex&gt;, --exclude-regex &lt;regex&gt;<a class="headerlink" href="#cmdoption-ctest-E" title="Permalink to this definition">¶</a></dt>
<dd>Exclude tests matching regular expression.
This option tells CTest to NOT run the tests whose names match the
given regular expression.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-LE">
-LE &lt;regex&gt;, --label-exclude &lt;regex&gt;<a class="headerlink" href="#cmdoption-ctest-LE" title="Permalink to this definition">¶</a></dt>
<dd>Exclude tests with labels matching regular expression.
This option tells CTest to NOT run the tests whose labels match the
given regular expression. When more than one <code class="docutils literal notranslate">-LE</code> option is given,
a test will only be excluded if each regular expression matches at least one
of the test's labels (i.e. the multiple <code class="docutils literal notranslate">-LE</code> labels form an <code class="docutils literal notranslate">AND</code>
relationship). See <a class="reference internal" href="#label-matching">Label Matching</a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-FA">
-FA &lt;regex&gt;, --fixture-exclude-any &lt;regex&gt;<a class="headerlink" href="#cmdoption-ctest-FA" title="Permalink to this definition">¶</a></dt>
<dd>Exclude fixtures matching <code class="docutils literal notranslate">&lt;regex&gt;</code> from automatically adding any tests to
the test set.
If a test in the set of tests to be executed requires a particular fixture,
that fixture's setup and cleanup tests would normally be added to the test set
automatically. This option prevents adding setup or cleanup tests for fixtures
matching the <code class="docutils literal notranslate">&lt;regex&gt;</code>. Note that all other fixture behavior is retained,
including test dependencies and skipping tests that have fixture setup tests
that fail.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-FS">
-FS &lt;regex&gt;, --fixture-exclude-setup &lt;regex&gt;<a class="headerlink" href="#cmdoption-ctest-FS" title="Permalink to this definition">¶</a></dt>
<dd>Same as <a class="reference internal" href="#cmdoption-ctest-FA"><code class="xref std std-option docutils literal notranslate">-FA</code></a> except only matching setup tests are
excluded.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-FC">
-FC &lt;regex&gt;, --fixture-exclude-cleanup &lt;regex&gt;<a class="headerlink" href="#cmdoption-ctest-FC" title="Permalink to this definition">¶</a></dt>
<dd>Same as <a class="reference internal" href="#cmdoption-ctest-FA"><code class="xref std std-option docutils literal notranslate">-FA</code></a> except only matching cleanup tests are
excluded.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-I">
-I [Start,End,Stride,test#,test#|Test file], --tests-information<a class="headerlink" href="#cmdoption-ctest-I" title="Permalink to this definition">¶</a></dt>
<dd>Run a specific number of tests by number.
This option causes CTest to run tests starting at number <code class="docutils literal notranslate">Start</code>,
ending at number <code class="docutils literal notranslate">End</code>, and incrementing by <code class="docutils literal notranslate">Stride</code>. Any additional
numbers after <code class="docutils literal notranslate">Stride</code> are considered individual test numbers. <code class="docutils literal notranslate">Start</code>,
<code class="docutils literal notranslate">End</code>, or <code class="docutils literal notranslate">Stride</code> can be empty. Optionally a file can be given that
contains the same syntax as the command line.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-U">
-U, --union<a class="headerlink" href="#cmdoption-ctest-U" title="Permalink to this definition">¶</a></dt>
<dd>Take the Union of <a class="reference internal" href="#cmdoption-ctest-I"><code class="xref std std-option docutils literal notranslate">-I</code></a> and <a class="reference internal" href="#cmdoption-ctest-R"><code class="xref std std-option docutils literal notranslate">-R</code></a>.
When both <a class="reference internal" href="#cmdoption-ctest-R"><code class="xref std std-option docutils literal notranslate">-R</code></a> and <a class="reference internal" href="#cmdoption-ctest-I"><code class="xref std std-option docutils literal notranslate">-I</code></a> are specified
by default the intersection of tests are run. By specifying <code class="docutils literal notranslate">-U</code> the union
of tests is run instead.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-rerun-failed">
--rerun-failed<a class="headerlink" href="#cmdoption-ctest-rerun-failed" title="Permalink to this definition">¶</a></dt>
<dd>Run only the tests that failed previously.
This option tells CTest to perform only the tests that failed during
its previous run. When this option is specified, CTest ignores all
other options intended to modify the list of tests to run (
<a class="reference internal" href="#cmdoption-ctest-L"><code class="xref std std-option docutils literal notranslate">-L</code></a>, <a class="reference internal" href="#cmdoption-ctest-R"><code class="xref std std-option docutils literal notranslate">-R</code></a>, <a class="reference internal" href="#cmdoption-ctest-E"><code class="xref std std-option docutils literal notranslate">-E</code></a>,
<a class="reference internal" href="#cmdoption-ctest-LE"><code class="xref std std-option docutils literal notranslate">-LE</code></a>, <a class="reference internal" href="#cmdoption-ctest-I"><code class="xref std std-option docutils literal notranslate">-I</code></a>, etc). In the event that
CTest runs and no tests fail, subsequent calls to CTest with the
<code class="docutils literal notranslate">--rerun-failed</code> option will run the set of tests that most recently
failed (if any).
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-repeat">
--repeat &lt;mode&gt;:&lt;n&gt;<a class="headerlink" href="#cmdoption-ctest-repeat" title="Permalink to this definition">¶</a></dt>
<dd>Run tests repeatedly based on the given <code class="docutils literal notranslate">&lt;mode&gt;</code> up to <code class="docutils literal notranslate">&lt;n&gt;</code> times.
The modes are:
<dl class="simple">
<dt><code class="docutils literal notranslate">until-fail</code></dt><dd>Require each test to run <code class="docutils literal notranslate">&lt;n&gt;</code> times without failing in order to pass.
This is useful in finding sporadic failures in test cases.
</dd>
<dt><code class="docutils literal notranslate">until-pass</code></dt><dd>Allow each test to run up to <code class="docutils literal notranslate">&lt;n&gt;</code> times in order to pass.
Repeats tests if they fail for any reason.
This is useful in tolerating sporadic failures in test cases.
</dd>
<dt><code class="docutils literal notranslate">after-timeout</code></dt><dd>Allow each test to run up to <code class="docutils literal notranslate">&lt;n&gt;</code> times in order to pass.
Repeats tests only if they timeout.
This is useful in tolerating sporadic timeouts in test cases
on busy machines.
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-repeat-until-fail">
--repeat-until-fail &lt;n&gt;<a class="headerlink" href="#cmdoption-ctest-repeat-until-fail" title="Permalink to this definition">¶</a></dt>
<dd>Equivalent to <a class="reference internal" href="#cmdoption-ctest-repeat"><code class="xref std std-option docutils literal notranslate">--repeat until-fail:&lt;n&gt;</code></a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-max-width">
--max-width &lt;width&gt;<a class="headerlink" href="#cmdoption-ctest-max-width" title="Permalink to this definition">¶</a></dt>
<dd>Set the max width for a test name to output.
Set the maximum width for each test name to show in the output.
This allows the user to widen the output to avoid clipping the test
name which can be very annoying.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-interactive-debug-mode">
--interactive-debug-mode [0|1]<a class="headerlink" href="#cmdoption-ctest-interactive-debug-mode" title="Permalink to this definition">¶</a></dt>
<dd>Set the interactive mode to <code class="docutils literal notranslate">0</code> or <code class="docutils literal notranslate">1</code>.
This option causes CTest to run tests in either an interactive mode
or a non-interactive mode. In dashboard mode (<code class="docutils literal notranslate">Experimental</code>, <code class="docutils literal notranslate">Nightly</code>,
<code class="docutils literal notranslate">Continuous</code>), the default is non-interactive. In non-interactive mode,
the environment variable <a class="reference internal" href="../envvar/DASHBOARD_TEST_FROM_CTEST.html#envvar:DASHBOARD_TEST_FROM_CTEST" title="DASHBOARD_TEST_FROM_CTEST"><code class="xref cmake cmake-envvar docutils literal notranslate">DASHBOARD_TEST_FROM_CTEST</code></a> is set.
Prior to CMake 3.11, interactive mode on Windows allowed system debug
popup windows to appear. Now, due to CTest's use of <code class="docutils literal notranslate">libuv</code> to launch
test processes, all system debug popup windows are always blocked.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-no-label-summary">
--no-label-summary<a class="headerlink" href="#cmdoption-ctest-no-label-summary" title="Permalink to this definition">¶</a></dt>
<dd>Disable timing summary information for labels.
This option tells CTest not to print summary information for each
label associated with the tests run. If there are no labels on the
tests, nothing extra is printed.
See <a class="reference internal" href="#label-and-subproject-summary">Label and Subproject Summary</a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-no-subproject-summary">
--no-subproject-summary<a class="headerlink" href="#cmdoption-ctest-no-subproject-summary" title="Permalink to this definition">¶</a></dt>
<dd>Disable timing summary information for subprojects.
This option tells CTest not to print summary information for each
subproject associated with the tests run. If there are no subprojects on the
tests, nothing extra is printed.
See <a class="reference internal" href="#label-and-subproject-summary">Label and Subproject Summary</a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-test-dir">
--test-dir &lt;dir&gt;<a class="headerlink" href="#cmdoption-ctest-test-dir" title="Permalink to this definition">¶</a></dt>
<dd>Specify the directory in which to look for tests.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-test-output-size-passed">
--test-output-size-passed &lt;size&gt;<a class="headerlink" href="#cmdoption-ctest-test-output-size-passed" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.4.
</div>
Limit the output for passed tests to <code class="docutils literal notranslate">&lt;size&gt;</code> bytes.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-test-output-size-failed">
--test-output-size-failed &lt;size&gt;<a class="headerlink" href="#cmdoption-ctest-test-output-size-failed" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.4.
</div>
Limit the output for failed tests to <code class="docutils literal notranslate">&lt;size&gt;</code> bytes.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-test-output-truncation">
--test-output-truncation &lt;mode&gt;<a class="headerlink" href="#cmdoption-ctest-test-output-truncation" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.24.
</div>
Truncate <code class="docutils literal notranslate">tail</code> (default), <code class="docutils literal notranslate">middle</code> or <code class="docutils literal notranslate">head</code> of test output once
maximum output size is reached.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-overwrite">
--overwrite<a class="headerlink" href="#cmdoption-ctest-overwrite" title="Permalink to this definition">¶</a></dt>
<dd>Overwrite CTest configuration option.
By default CTest uses configuration options from configuration file.
This option will overwrite the configuration option.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-force-new-ctest-process">
--force-new-ctest-process<a class="headerlink" href="#cmdoption-ctest-force-new-ctest-process" title="Permalink to this definition">¶</a></dt>
<dd>Run child CTest instances as new processes.
By default CTest will run child CTest instances within the same
process. If this behavior is not desired, this argument will
enforce new processes for child CTest processes.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-schedule-random">
--schedule-random<a class="headerlink" href="#cmdoption-ctest-schedule-random" title="Permalink to this definition">¶</a></dt>
<dd>Use a random order for scheduling tests.
This option will run the tests in a random order. It is commonly
used to detect implicit dependencies in a test suite.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-submit-index">
--submit-index<a class="headerlink" href="#cmdoption-ctest-submit-index" title="Permalink to this definition">¶</a></dt>
<dd>Legacy option for old Dart2 dashboard server feature.
Do not use.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-timeout">
--timeout &lt;seconds&gt;<a class="headerlink" href="#cmdoption-ctest-timeout" title="Permalink to this definition">¶</a></dt>
<dd>Set the default test timeout.
This option effectively sets a timeout on all tests that do not
already have a timeout set on them via the <a class="reference internal" href="../prop_test/TIMEOUT.html#prop_test:TIMEOUT" title="TIMEOUT"><code class="xref cmake cmake-prop_test docutils literal notranslate">TIMEOUT</code></a>
property.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-stop-time">
--stop-time &lt;time&gt;<a class="headerlink" href="#cmdoption-ctest-stop-time" title="Permalink to this definition">¶</a></dt>
<dd>Set a time at which all tests should stop running.
Set a real time of day at which all tests should timeout. Example:
<code class="docutils literal notranslate">7:00:00 -0400</code>. Any time format understood by the curl date parser
is accepted. Local time is assumed if no timezone is specified.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-print-labels">
--print-labels<a class="headerlink" href="#cmdoption-ctest-print-labels" title="Permalink to this definition">¶</a></dt>
<dd>Print all available test labels.
This option will not run any tests, it will simply print the list of
all labels associated with the test set.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-no-tests">
--no-tests=&lt;action&gt;<a class="headerlink" href="#cmdoption-ctest-no-tests" title="Permalink to this definition">¶</a></dt>
<dd>Regard no tests found either as error (when <code class="docutils literal notranslate">&lt;action&gt;</code> is set to
<code class="docutils literal notranslate">error</code>) or ignore it (when <code class="docutils literal notranslate">&lt;action&gt;</code> is set to <code class="docutils literal notranslate">ignore</code>).
If no tests were found, the default behavior of CTest is to always log an
error message but to return an error code in script mode only. This option
unifies the behavior of CTest by either returning an error code if no tests
were found or by ignoring it.
<div class="versionadded">
New in version 3.26.
</div>
This option can also be set by setting the <a class="reference internal" href="../envvar/CTEST_NO_TESTS_ACTION.html#envvar:CTEST_NO_TESTS_ACTION" title="CTEST_NO_TESTS_ACTION"><code class="xref cmake cmake-envvar docutils literal notranslate">CTEST_NO_TESTS_ACTION</code></a>
environment variable.
</dd></dl>

</section>
<section id="view-help">
<h2><a class="toc-backref" href="#id19" role="doc-backlink">View Help</a><a class="headerlink" href="#view-help" title="Permalink to this heading">¶</a></h2>
To print version details or selected pages from the CMake documentation,
use one of the following options:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-version">
-version [&lt;file&gt;], --version [&lt;file&gt;], /V [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-version" title="Permalink to this definition">¶</a></dt>
<dd>Show program name/version banner and exit.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-h">
-h, -H, --help, -help, -usage, /?<a class="headerlink" href="#cmdoption-ctest-h" title="Permalink to this definition">¶</a></dt>
<dd>Print usage information and exit.
Usage describes the basic command line interface and its options.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-full">
--help-full [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-full" title="Permalink to this definition">¶</a></dt>
<dd>Print all help manuals and exit.
All manuals are printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-manual">
--help-manual &lt;man&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-manual" title="Permalink to this definition">¶</a></dt>
<dd>Print one help manual and exit.
The specified manual is printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-manual-list">
--help-manual-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-manual-list" title="Permalink to this definition">¶</a></dt>
<dd>List help manuals available and exit.
The list contains all manuals for which help may be obtained by
using the <code class="docutils literal notranslate">--help-manual</code> option followed by a manual name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-command">
--help-command &lt;cmd&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-command" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one command and exit.
The <a class="reference internal" href="cmake-commands.7.html#manual:cmake-commands(7)" title="cmake-commands(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-commands(7)</code></a> manual entry for <code class="docutils literal notranslate">&lt;cmd&gt;</code> is
printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-command-list">
--help-command-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-command-list" title="Permalink to this definition">¶</a></dt>
<dd>List commands with help available and exit.
The list contains all commands for which help may be obtained by
using the <code class="docutils literal notranslate">--help-command</code> option followed by a command name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-commands">
--help-commands [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-commands" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-commands manual and exit.
The <a class="reference internal" href="cmake-commands.7.html#manual:cmake-commands(7)" title="cmake-commands(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-commands(7)</code></a> manual is printed in a
human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-module">
--help-module &lt;mod&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-module" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one module and exit.
The <a class="reference internal" href="cmake-modules.7.html#manual:cmake-modules(7)" title="cmake-modules(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-modules(7)</code></a> manual entry for <code class="docutils literal notranslate">&lt;mod&gt;</code> is printed
in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-module-list">
--help-module-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-module-list" title="Permalink to this definition">¶</a></dt>
<dd>List modules with help available and exit.
The list contains all modules for which help may be obtained by
using the <code class="docutils literal notranslate">--help-module</code> option followed by a module name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-modules">
--help-modules [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-modules" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-modules manual and exit.
The <a class="reference internal" href="cmake-modules.7.html#manual:cmake-modules(7)" title="cmake-modules(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-modules(7)</code></a> manual is printed in a human-readable
text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-policy">
--help-policy &lt;cmp&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-policy" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one policy and exit.
The <a class="reference internal" href="cmake-policies.7.html#manual:cmake-policies(7)" title="cmake-policies(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-policies(7)</code></a> manual entry for <code class="docutils literal notranslate">&lt;cmp&gt;</code> is
printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-policy-list">
--help-policy-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-policy-list" title="Permalink to this definition">¶</a></dt>
<dd>List policies with help available and exit.
The list contains all policies for which help may be obtained by
using the <code class="docutils literal notranslate">--help-policy</code> option followed by a policy name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-policies">
--help-policies [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-policies" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-policies manual and exit.
The <a class="reference internal" href="cmake-policies.7.html#manual:cmake-policies(7)" title="cmake-policies(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-policies(7)</code></a> manual is printed in a
human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-property">
--help-property &lt;prop&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-property" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one property and exit.
The <a class="reference internal" href="cmake-properties.7.html#manual:cmake-properties(7)" title="cmake-properties(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-properties(7)</code></a> manual entries for <code class="docutils literal notranslate">&lt;prop&gt;</code> are
printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-property-list">
--help-property-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-property-list" title="Permalink to this definition">¶</a></dt>
<dd>List properties with help available and exit.
The list contains all properties for which help may be obtained by
using the <code class="docutils literal notranslate">--help-property</code> option followed by a property name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-properties">
--help-properties [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-properties" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-properties manual and exit.
The <a class="reference internal" href="cmake-properties.7.html#manual:cmake-properties(7)" title="cmake-properties(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-properties(7)</code></a> manual is printed in a
human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-variable">
--help-variable &lt;var&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-variable" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one variable and exit.
The <a class="reference internal" href="cmake-variables.7.html#manual:cmake-variables(7)" title="cmake-variables(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-variables(7)</code></a> manual entry for <code class="docutils literal notranslate">&lt;var&gt;</code> is
printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-variable-list">
--help-variable-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-variable-list" title="Permalink to this definition">¶</a></dt>
<dd>List variables with help available and exit.
The list contains all variables for which help may be obtained by
using the <code class="docutils literal notranslate">--help-variable</code> option followed by a variable name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-help-variables">
--help-variables [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-help-variables" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-variables manual and exit.
The <a class="reference internal" href="cmake-variables.7.html#manual:cmake-variables(7)" title="cmake-variables(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-variables(7)</code></a> manual is printed in a
human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

</section>
<section id="label-matching">
<h2><a class="toc-backref" href="#id20" role="doc-backlink">Label Matching</a><a class="headerlink" href="#label-matching" title="Permalink to this heading">¶</a></h2>
Tests may have labels attached to them. Tests may be included
or excluded from a test run by filtering on the labels.
Each individual filter is a regular expression applied to
the labels attached to a test.
When <a class="reference internal" href="#cmdoption-ctest-L"><code class="xref std std-option docutils literal notranslate">-L</code></a> is used, in order for a test to be included in a
test run, each regular expression must match at least one
label. Using more than one <a class="reference internal" href="#cmdoption-ctest-L"><code class="xref std std-option docutils literal notranslate">-L</code></a> option means &quot;match all
of these&quot;.
The <a class="reference internal" href="#cmdoption-ctest-LE"><code class="xref std std-option docutils literal notranslate">-LE</code></a> option works just like <a class="reference internal" href="#cmdoption-ctest-L"><code class="xref std std-option docutils literal notranslate">-L</code></a>,
but excludes tests rather than including them. A test is excluded if each
regular expression matches at least one label.
If a test has no labels attached to it, then <a class="reference internal" href="#cmdoption-ctest-L"><code class="xref std std-option docutils literal notranslate">-L</code></a> will never
include that test, and <a class="reference internal" href="#cmdoption-ctest-LE"><code class="xref std std-option docutils literal notranslate">-LE</code></a> will never exclude that test.
As an example of tests with labels, consider five tests,
with the following labels:
<ul class="simple">
<li>test1 has labels tuesday and production</li>
<li>test2 has labels tuesday and test</li>
<li>test3 has labels wednesday and production</li>
<li>test4 has label wednesday</li>
<li>test5 has labels friday and test</li>
</ul>
Running ctest with <code class="docutils literal notranslate">-L tuesday -L test</code> will select test2, which has
both labels. Running CTest with <code class="docutils literal notranslate">-L test</code> will select test2 and
test5, because both of them have a label that matches that regular
expression.
Because the matching works with regular expressions, take note that
running CTest with <code class="docutils literal notranslate">-L es</code> will match all five tests.
To select the tuesday and wednesday tests together, use a single
regular expression that matches either of them, like <code class="docutils literal notranslate">-L &quot;tue|wed&quot;</code>.
</section>
<section id="label-and-subproject-summary">
<h2><a class="toc-backref" href="#id21" role="doc-backlink">Label and Subproject Summary</a><a class="headerlink" href="#label-and-subproject-summary" title="Permalink to this heading">¶</a></h2>
CTest prints timing summary information for each <code class="docutils literal notranslate">LABEL</code> and subproject
associated with the tests run. The label time summary will not include labels
that are mapped to subprojects.
<div class="versionadded">
New in version 3.22: Labels added dynamically during test execution are also reported in the
timing summary. See <a class="reference internal" href="../command/ctest_test.html#additional-labels">Additional Labels</a>.
</div>
When the <a class="reference internal" href="../prop_test/PROCESSORS.html#prop_test:PROCESSORS" title="PROCESSORS"><code class="xref cmake cmake-prop_test docutils literal notranslate">PROCESSORS</code></a> test property is set, CTest will display a
weighted test timing result in label and subproject summaries. The time is
reported with <cite>sec*proc</cite> instead of just <cite>sec</cite>.
The weighted time summary reported for each label or subproject <code class="docutils literal notranslate">j</code>
is computed as:
<div class="highlight-none notranslate"><div class="highlight"><pre>Weighted Time Summary for Label/Subproject j =
 sum(raw_test_time[j,i] * num_processors[j,i], i=1...num_tests[j])

for labels/subprojects j=1...total
</pre></div>
</div>
where:
<ul class="simple">
<li><code class="docutils literal notranslate">raw_test_time[j,i]</code>: Wall-clock time for the <code class="docutils literal notranslate">i</code> test
for the <code class="docutils literal notranslate">j</code> label or subproject</li>
<li><code class="docutils literal notranslate">num_processors[j,i]</code>: Value of the CTest <a class="reference internal" href="../prop_test/PROCESSORS.html#prop_test:PROCESSORS" title="PROCESSORS"><code class="xref cmake cmake-prop_test docutils literal notranslate">PROCESSORS</code></a> property
for the <code class="docutils literal notranslate">i</code> test for the <code class="docutils literal notranslate">j</code> label or subproject</li>
<li><code class="docutils literal notranslate">num_tests[j]</code>: Number of tests associated with the <code class="docutils literal notranslate">j</code> label or subproject</li>
<li><code class="docutils literal notranslate">total</code>: Total number of labels or subprojects that have at least one test run</li>
</ul>
Therefore, the weighted time summary for each label or subproject represents
the amount of time that CTest gave to run the tests for each label or
subproject and gives a good representation of the total expense of the tests
for each label or subproject when compared to other labels or subprojects.
For example, if <code class="docutils literal notranslate">SubprojectA</code> showed <code class="docutils literal notranslate">100 sec*proc</code> and <code class="docutils literal notranslate">SubprojectB</code> showed
<code class="docutils literal notranslate">10 sec*proc</code>, then CTest allocated approximately 10 times the CPU/core time
to run the tests for <code class="docutils literal notranslate">SubprojectA</code> than for <code class="docutils literal notranslate">SubprojectB</code> (e.g. so if effort
is going to be expended to reduce the cost of the test suite for the whole
project, then reducing the cost of the test suite for <code class="docutils literal notranslate">SubprojectA</code> would
likely have a larger impact than effort to reduce the cost of the test suite
for <code class="docutils literal notranslate">SubprojectB</code>).
</section>
<section id="build-and-test-mode">
<h2><a class="toc-backref" href="#id22" role="doc-backlink">Build and Test Mode</a><a class="headerlink" href="#build-and-test-mode" title="Permalink to this heading">¶</a></h2>
CTest provides a command-line signature to configure (i.e. run cmake on),
build, and/or execute a test:
<div class="highlight-none notranslate"><div class="highlight"><pre>ctest --build-and-test &lt;path-to-source&gt; &lt;path-to-build&gt;
 --build-generator &lt;generator&gt;
 [&lt;options&gt;...]
 [--build-options &lt;opts&gt;...]
 [--test-command &lt;command&gt; [&lt;args&gt;...]]
</pre></div>
</div>
The configure and test steps are optional. The arguments to this command line
are the source and binary directories. The <code class="docutils literal notranslate">--build-generator</code> option must
be provided to use <code class="docutils literal notranslate">--build-and-test</code>. If <code class="docutils literal notranslate">--test-command</code> is specified
then that will be run after the build is complete. Other options that affect
this mode include:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-and-test">
--build-and-test<a class="headerlink" href="#cmdoption-ctest-build-and-test" title="Permalink to this definition">¶</a></dt>
<dd>Switch into the build and test mode.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-target">
--build-target<a class="headerlink" href="#cmdoption-ctest-build-target" title="Permalink to this definition">¶</a></dt>
<dd>Specify a specific target to build. The option can be given multiple times
with different targets, in which case each target is built in turn.
A clean will be done before building each target unless the
<a class="reference internal" href="#cmdoption-ctest-build-noclean"><code class="xref std std-option docutils literal notranslate">--build-noclean</code></a> option is given.
If no <code class="docutils literal notranslate">--build-target</code> is specified, the <code class="docutils literal notranslate">all</code> target is built.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-nocmake">
--build-nocmake<a class="headerlink" href="#cmdoption-ctest-build-nocmake" title="Permalink to this definition">¶</a></dt>
<dd>Run the build without running cmake first.
Skip the cmake step.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-run-dir">
--build-run-dir<a class="headerlink" href="#cmdoption-ctest-build-run-dir" title="Permalink to this definition">¶</a></dt>
<dd>Specify directory to run programs from.
Directory where programs will be after it has been compiled.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-two-config">
--build-two-config<a class="headerlink" href="#cmdoption-ctest-build-two-config" title="Permalink to this definition">¶</a></dt>
<dd>Run CMake twice.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-exe-dir">
--build-exe-dir<a class="headerlink" href="#cmdoption-ctest-build-exe-dir" title="Permalink to this definition">¶</a></dt>
<dd>Specify the directory for the executable.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-generator">
--build-generator<a class="headerlink" href="#cmdoption-ctest-build-generator" title="Permalink to this definition">¶</a></dt>
<dd>Specify the generator to use. See the <a class="reference internal" href="cmake-generators.7.html#manual:cmake-generators(7)" title="cmake-generators(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-generators(7)</code></a> manual.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-generator-platform">
--build-generator-platform<a class="headerlink" href="#cmdoption-ctest-build-generator-platform" title="Permalink to this definition">¶</a></dt>
<dd>Specify the generator-specific platform.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-generator-toolset">
--build-generator-toolset<a class="headerlink" href="#cmdoption-ctest-build-generator-toolset" title="Permalink to this definition">¶</a></dt>
<dd>Specify the generator-specific toolset.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-project">
--build-project<a class="headerlink" href="#cmdoption-ctest-build-project" title="Permalink to this definition">¶</a></dt>
<dd>Specify the name of the project to build.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-makeprogram">
--build-makeprogram<a class="headerlink" href="#cmdoption-ctest-build-makeprogram" title="Permalink to this definition">¶</a></dt>
<dd>Specify the explicit make program to be used by CMake when configuring and
building the project. Only applicable for Make and Ninja based generators.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-noclean">
--build-noclean<a class="headerlink" href="#cmdoption-ctest-build-noclean" title="Permalink to this definition">¶</a></dt>
<dd>Skip the make clean step.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-config-sample">
--build-config-sample<a class="headerlink" href="#cmdoption-ctest-build-config-sample" title="Permalink to this definition">¶</a></dt>
<dd>A sample executable to use to determine the configuration that
should be used. e.g. <code class="docutils literal notranslate">Debug</code>, <code class="docutils literal notranslate">Release</code> etc.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-build-options">
--build-options<a class="headerlink" href="#cmdoption-ctest-build-options" title="Permalink to this definition">¶</a></dt>
<dd>Additional options for configuring the build (i.e. for CMake, not for
the build tool). Note that if this is specified, the <code class="docutils literal notranslate">--build-options</code>
keyword and its arguments must be the last option given on the command
line, with the possible exception of <code class="docutils literal notranslate">--test-command</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-test-command">
--test-command<a class="headerlink" href="#cmdoption-ctest-test-command" title="Permalink to this definition">¶</a></dt>
<dd>The command to run as the test step with the
<a class="reference internal" href="#cmdoption-ctest-build-and-test"><code class="xref std std-option docutils literal notranslate">--build-and-test</code></a> option.
All arguments following this keyword will be assumed to be part of the
test command line, so it must be the last option given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-test-timeout">
--test-timeout<a class="headerlink" href="#cmdoption-ctest-test-timeout" title="Permalink to this definition">¶</a></dt>
<dd>The time limit in seconds
</dd></dl>

</section>
<section id="dashboard-client">
<h2><a class="toc-backref" href="#id23" role="doc-backlink">Dashboard Client</a><a class="headerlink" href="#dashboard-client" title="Permalink to this heading">¶</a></h2>
CTest can operate as a client for the <a class="reference internal" href="#cdash">CDash</a> software quality dashboard
application. As a dashboard client, CTest performs a sequence of steps
to configure, build, and test software, and then submits the results to
a <a class="reference internal" href="#cdash">CDash</a> server. The command-line signature used to submit to <a class="reference internal" href="#cdash">CDash</a> is:
<div class="highlight-none notranslate"><div class="highlight"><pre>ctest -D &lt;dashboard&gt; [-- &lt;dashboard-options&gt;...]
ctest -M &lt;model&gt; -T &lt;action&gt; [-- &lt;dashboard-options&gt;...]
ctest -S &lt;script&gt; [-- &lt;dashboard-options&gt;...]
ctest -SP &lt;script&gt; [-- &lt;dashboard-options&gt;...]
</pre></div>
</div>
Options for Dashboard Client include:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-D">
-D &lt;dashboard&gt;, --dashboard &lt;dashboard&gt;<a class="headerlink" href="#cmdoption-ctest-D" title="Permalink to this definition">¶</a></dt>
<dd>Execute dashboard test.
This option tells CTest to act as a CDash client and perform a
dashboard test. All tests are <code class="docutils literal notranslate">&lt;Mode&gt;&lt;Test&gt;</code>, where <code class="docutils literal notranslate">&lt;Mode&gt;</code> can be
<code class="docutils literal notranslate">Experimental</code>, <code class="docutils literal notranslate">Nightly</code>, and <code class="docutils literal notranslate">Continuous</code>, and <code class="docutils literal notranslate">&lt;Test&gt;</code> can be
<code class="docutils literal notranslate">Start</code>, <code class="docutils literal notranslate">Update</code>, <code class="docutils literal notranslate">Configure</code>, <code class="docutils literal notranslate">Build</code>, <code class="docutils literal notranslate">Test</code>,
<code class="docutils literal notranslate">Coverage</code>, and <code class="docutils literal notranslate">Submit</code>.
If <code class="docutils literal notranslate">&lt;dashboard&gt;</code> is not one of the recognized <code class="docutils literal notranslate">&lt;Mode&gt;&lt;Test&gt;</code> values,
this will be treated as a variable definition instead (see the
<a class="reference internal" href="#dashboard-options">dashboard-options</a> further below).
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-M">
-M &lt;model&gt;, --test-model &lt;model&gt;<a class="headerlink" href="#cmdoption-ctest-M" title="Permalink to this definition">¶</a></dt>
<dd>Sets the model for a dashboard.
This option tells CTest to act as a CDash client where the <code class="docutils literal notranslate">&lt;model&gt;</code>
can be <code class="docutils literal notranslate">Experimental</code>, <code class="docutils literal notranslate">Nightly</code>, and <code class="docutils literal notranslate">Continuous</code>.
Combining <code class="docutils literal notranslate">-M</code> and <a class="reference internal" href="#cmdoption-ctest-T"><code class="xref std std-option docutils literal notranslate">-T</code></a> is similar to
<a class="reference internal" href="#cmdoption-ctest-2"><code class="xref std std-option docutils literal notranslate">-D</code></a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-T">
-T &lt;action&gt;, --test-action &lt;action&gt;<a class="headerlink" href="#cmdoption-ctest-T" title="Permalink to this definition">¶</a></dt>
<dd>Sets the dashboard action to perform.
This option tells CTest to act as a CDash client and perform some
action such as <code class="docutils literal notranslate">start</code>, <code class="docutils literal notranslate">build</code>, <code class="docutils literal notranslate">test</code> etc. See
<a class="reference internal" href="#dashboard-client-steps">Dashboard Client Steps</a> for the full list of actions.
Combining <a class="reference internal" href="#cmdoption-ctest-M"><code class="xref std std-option docutils literal notranslate">-M</code></a> and <code class="docutils literal notranslate">-T</code> is similar to
<a class="reference internal" href="#cmdoption-ctest-2"><code class="xref std std-option docutils literal notranslate">-D</code></a>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-S">
-S &lt;script&gt;, --script &lt;script&gt;<a class="headerlink" href="#cmdoption-ctest-S" title="Permalink to this definition">¶</a></dt>
<dd>Execute a dashboard for a configuration.
This option tells CTest to load in a configuration script which sets
a number of parameters such as the binary and source directories.
Then CTest will do what is required to create and run a dashboard.
This option basically sets up a dashboard and then runs <a class="reference internal" href="#cmdoption-ctest-2"><code class="xref std std-option docutils literal notranslate">ctest -D</code></a>
with the appropriate options.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-SP">
-SP &lt;script&gt;, --script-new-process &lt;script&gt;<a class="headerlink" href="#cmdoption-ctest-SP" title="Permalink to this definition">¶</a></dt>
<dd>Execute a dashboard for a configuration.
This option does the same operations as <a class="reference internal" href="#cmdoption-ctest-S"><code class="xref std std-option docutils literal notranslate">-S</code></a> but it
will do them in a separate process. This is primarily useful in cases
where the script may modify the environment and you do not want the modified
environment to impact other <a class="reference internal" href="#cmdoption-ctest-S"><code class="xref std std-option docutils literal notranslate">-S</code></a> scripts.
</dd></dl>

The available <code class="docutils literal notranslate">&lt;dashboard-options&gt;</code> are the following:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-2">
-D &lt;var&gt;:&lt;type&gt;=&lt;value&gt;<a class="headerlink" href="#cmdoption-ctest-2" title="Permalink to this definition">¶</a></dt>
<dd>Define a variable for script mode.
Pass in variable values on the command line. Use in conjunction
with <a class="reference internal" href="#cmdoption-ctest-S"><code class="xref std std-option docutils literal notranslate">-S</code></a> to pass variable values to a dashboard script.
Parsing <code class="docutils literal notranslate">-D</code> arguments as variable values is only attempted if the value
following <code class="docutils literal notranslate">-D</code> does not match any of the known dashboard types.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-group">
--group &lt;group&gt;<a class="headerlink" href="#cmdoption-ctest-group" title="Permalink to this definition">¶</a></dt>
<dd>Specify what group you'd like to submit results to
Submit dashboard to specified group instead of default one. By
default, the dashboard is submitted to Nightly, Experimental, or
Continuous group, but by specifying this option, the group can be
arbitrary.
This replaces the deprecated option <code class="docutils literal notranslate">--track</code>.
Despite the name change its behavior is unchanged.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-A">
-A &lt;file&gt;, --add-notes &lt;file&gt;<a class="headerlink" href="#cmdoption-ctest-A" title="Permalink to this definition">¶</a></dt>
<dd>Add a notes file with submission.
This option tells CTest to include a notes file when submitting
dashboard.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-tomorrow-tag">
--tomorrow-tag<a class="headerlink" href="#cmdoption-ctest-tomorrow-tag" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">Nightly</code> or <code class="docutils literal notranslate">Experimental</code> starts with next day tag.
This is useful if the build will not finish in one day.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-extra-submit">
--extra-submit &lt;file&gt;[;&lt;file&gt;]<a class="headerlink" href="#cmdoption-ctest-extra-submit" title="Permalink to this definition">¶</a></dt>
<dd>Submit extra files to the dashboard.
This option will submit extra files to the dashboard.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-http1.0">
--http1.0<a class="headerlink" href="#cmdoption-ctest-http1.0" title="Permalink to this definition">¶</a></dt>
<dd>Submit using <cite>HTTP 1.0</cite>.
This option will force CTest to use <cite>HTTP 1.0</cite> to submit files to the
dashboard, instead of <cite>HTTP 1.1</cite>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ctest-no-compress-output">
--no-compress-output<a class="headerlink" href="#cmdoption-ctest-no-compress-output" title="Permalink to this definition">¶</a></dt>
<dd>Do not compress test output when submitting.
This flag will turn off automatic compression of test output. Use
this to maintain compatibility with an older version of CDash which
doesn't support compressed test output.
</dd></dl>

<section id="dashboard-client-steps">
<h3><a class="toc-backref" href="#id24" role="doc-backlink">Dashboard Client Steps</a><a class="headerlink" href="#dashboard-client-steps" title="Permalink to this heading">¶</a></h3>
CTest defines an ordered list of testing steps of which some or all may
be run as a dashboard client:
<dl class="simple">
<dt><code class="docutils literal notranslate">Start</code></dt><dd>Start a new dashboard submission to be composed of results recorded
by the following steps.
See the <a class="reference internal" href="#ctest-start-step">CTest Start Step</a> section below.
</dd>
<dt><code class="docutils literal notranslate">Update</code></dt><dd>Update the source tree from its version control repository.
Record the old and new versions and the list of updated source files.
See the <a class="reference internal" href="#ctest-update-step">CTest Update Step</a> section below.
</dd>
<dt><code class="docutils literal notranslate">Configure</code></dt><dd>Configure the software by running a command in the build tree.
Record the configuration output log.
See the <a class="reference internal" href="#ctest-configure-step">CTest Configure Step</a> section below.
</dd>
<dt><code class="docutils literal notranslate">Build</code></dt><dd>Build the software by running a command in the build tree.
Record the build output log and detect warnings and errors.
See the <a class="reference internal" href="#ctest-build-step">CTest Build Step</a> section below.
</dd>
<dt><code class="docutils literal notranslate">Test</code></dt><dd>Test the software by loading a <code class="docutils literal notranslate">CTestTestfile.cmake</code>
from the build tree and executing the defined tests.
Record the output and result of each test.
See the <a class="reference internal" href="#ctest-test-step">CTest Test Step</a> section below.
</dd>
<dt><code class="docutils literal notranslate">Coverage</code></dt><dd>Compute coverage of the source code by running a coverage
analysis tool and recording its output.
See the <a class="reference internal" href="#ctest-coverage-step">CTest Coverage Step</a> section below.
</dd>
<dt><code class="docutils literal notranslate">MemCheck</code></dt><dd>Run the software test suite through a memory check tool.
Record the test output, results, and issues reported by the tool.
See the <a class="reference internal" href="#ctest-memcheck-step">CTest MemCheck Step</a> section below.
</dd>
<dt><code class="docutils literal notranslate">Submit</code></dt><dd>Submit results recorded from other testing steps to the
software quality dashboard server.
See the <a class="reference internal" href="#ctest-submit-step">CTest Submit Step</a> section below.
</dd>
</dl>
</section>
<section id="dashboard-client-modes">
<h3><a class="toc-backref" href="#id25" role="doc-backlink">Dashboard Client Modes</a><a class="headerlink" href="#dashboard-client-modes" title="Permalink to this heading">¶</a></h3>
CTest defines three modes of operation as a dashboard client:
<dl class="simple">
<dt><code class="docutils literal notranslate">Nightly</code></dt><dd>This mode is intended to be invoked once per day, typically at night.
It enables the <code class="docutils literal notranslate">Start</code>, <code class="docutils literal notranslate">Update</code>, <code class="docutils literal notranslate">Configure</code>, <code class="docutils literal notranslate">Build</code>, <code class="docutils literal notranslate">Test</code>,
<code class="docutils literal notranslate">Coverage</code>, and <code class="docutils literal notranslate">Submit</code> steps by default. Selected steps run even
if the <code class="docutils literal notranslate">Update</code> step reports no changes to the source tree.
</dd>
<dt><code class="docutils literal notranslate">Continuous</code></dt><dd>This mode is intended to be invoked repeatedly throughout the day.
It enables the <code class="docutils literal notranslate">Start</code>, <code class="docutils literal notranslate">Update</code>, <code class="docutils literal notranslate">Configure</code>, <code class="docutils literal notranslate">Build</code>, <code class="docutils literal notranslate">Test</code>,
<code class="docutils literal notranslate">Coverage</code>, and <code class="docutils literal notranslate">Submit</code> steps by default, but exits after the
<code class="docutils literal notranslate">Update</code> step if it reports no changes to the source tree.
</dd>
<dt><code class="docutils literal notranslate">Experimental</code></dt><dd>This mode is intended to be invoked by a developer to test local changes.
It enables the <code class="docutils literal notranslate">Start</code>, <code class="docutils literal notranslate">Configure</code>, <code class="docutils literal notranslate">Build</code>, <code class="docutils literal notranslate">Test</code>, <code class="docutils literal notranslate">Coverage</code>,
and <code class="docutils literal notranslate">Submit</code> steps by default.
</dd>
</dl>
</section>
<section id="dashboard-client-via-ctest-command-line">
<h3><a class="toc-backref" href="#id26" role="doc-backlink">Dashboard Client via CTest Command-Line</a><a class="headerlink" href="#dashboard-client-via-ctest-command-line" title="Permalink to this heading">¶</a></h3>
CTest can perform testing on an already-generated build tree.
Run the ctest command with the current working directory set
to the build tree and use one of these signatures:
<div class="highlight-none notranslate"><div class="highlight"><pre>ctest -D &lt;mode&gt;[&lt;step&gt;]
ctest -M &lt;mode&gt; [-T &lt;step&gt;]...
</pre></div>
</div>
The <code class="docutils literal notranslate">&lt;mode&gt;</code> must be one of the above <a class="reference internal" href="#dashboard-client-modes">Dashboard Client Modes</a>,
and each <code class="docutils literal notranslate">&lt;step&gt;</code> must be one of the above <a class="reference internal" href="#dashboard-client-steps">Dashboard Client Steps</a>.
CTest reads the <a class="reference internal" href="#dashboard-client-configuration">Dashboard Client Configuration</a> settings from
a file in the build tree called either <code class="docutils literal notranslate">CTestConfiguration.ini</code>
or <code class="docutils literal notranslate">DartConfiguration.tcl</code> (the names are historical). The format
of the file is:
<div class="highlight-none notranslate"><div class="highlight"><pre># Lines starting in &#39;#&#39; are comments.
# Other non-blank lines are key-value pairs.
&lt;setting&gt;: &lt;value&gt;
</pre></div>
</div>
where <code class="docutils literal notranslate">&lt;setting&gt;</code> is the setting name and <code class="docutils literal notranslate">&lt;value&gt;</code> is the
setting value.
In build trees generated by CMake, this configuration file is
generated by the <a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module if included by the project.
The module uses variables to obtain a value for each setting
as documented with the settings below.
</section>
<section id="dashboard-client-via-ctest-script">
<h3><a class="toc-backref" href="#id27" role="doc-backlink">Dashboard Client via CTest Script</a><a class="headerlink" href="#dashboard-client-via-ctest-script" title="Permalink to this heading">¶</a></h3>
CTest can perform testing driven by a <a class="reference internal" href="cmake-language.7.html#manual:cmake-language(7)" title="cmake-language(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-language(7)</code></a>
script that creates and maintains the source and build tree as
well as performing the testing steps. Run the ctest command
with the current working directory set outside of any build tree
and use one of these signatures:
<div class="highlight-none notranslate"><div class="highlight"><pre>ctest -S &lt;script&gt;
ctest -SP &lt;script&gt;
</pre></div>
</div>
The <code class="docutils literal notranslate">&lt;script&gt;</code> file must call <a class="reference internal" href="cmake-commands.7.html#ctest-commands">CTest Commands</a> commands
to run testing steps explicitly as documented below. The commands
obtain <a class="reference internal" href="#dashboard-client-configuration">Dashboard Client Configuration</a> settings from their
arguments or from variables set in the script.
</section>
</section>
<section id="dashboard-client-configuration">
<h2><a class="toc-backref" href="#id28" role="doc-backlink">Dashboard Client Configuration</a><a class="headerlink" href="#dashboard-client-configuration" title="Permalink to this heading">¶</a></h2>
The <a class="reference internal" href="#dashboard-client-steps">Dashboard Client Steps</a> may be configured by named
settings as documented in the following sections.
<section id="ctest-start-step">
<h3><a class="toc-backref" href="#id29" role="doc-backlink">CTest Start Step</a><a class="headerlink" href="#ctest-start-step" title="Permalink to this heading">¶</a></h3>
Start a new dashboard submission to be composed of results recorded
by the following steps.
In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <a class="reference internal" href="../command/ctest_start.html#command:ctest_start" title="ctest_start"><code class="xref cmake cmake-command docutils literal notranslate">ctest_start()</code></a> command runs this step.
Arguments to the command may specify some of the step settings.
The command first runs the command-line specified by the
<code class="docutils literal notranslate">CTEST_CHECKOUT_COMMAND</code> variable, if set, to initialize the source
directory.
Configuration settings include:
<dl class="simple">
<dt><code class="docutils literal notranslate">BuildDirectory</code></dt><dd>The full path to the project build tree.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_BINARY_DIRECTORY.html#variable:CTEST_BINARY_DIRECTORY" title="CTEST_BINARY_DIRECTORY"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_BINARY_DIRECTORY</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <a class="reference internal" href="../variable/PROJECT_BINARY_DIR.html#variable:PROJECT_BINARY_DIR" title="PROJECT_BINARY_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">PROJECT_BINARY_DIR</code></a></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">SourceDirectory</code></dt><dd>The full path to the project source tree.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_SOURCE_DIRECTORY.html#variable:CTEST_SOURCE_DIRECTORY" title="CTEST_SOURCE_DIRECTORY"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_SOURCE_DIRECTORY</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <a class="reference internal" href="../variable/PROJECT_SOURCE_DIR.html#variable:PROJECT_SOURCE_DIR" title="PROJECT_SOURCE_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">PROJECT_SOURCE_DIR</code></a></li>
</ul>
</dd>
</dl>
</section>
<section id="ctest-update-step">
<h3><a class="toc-backref" href="#id30" role="doc-backlink">CTest Update Step</a><a class="headerlink" href="#ctest-update-step" title="Permalink to this heading">¶</a></h3>
In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <a class="reference internal" href="../command/ctest_update.html#command:ctest_update" title="ctest_update"><code class="xref cmake cmake-command docutils literal notranslate">ctest_update()</code></a> command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings to specify the version control tool include:
<dl>
<dt><code class="docutils literal notranslate">BZRCommand</code></dt><dd><code class="docutils literal notranslate">bzr</code> command-line tool to use if source tree is managed by Bazaar.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_BZR_COMMAND.html#variable:CTEST_BZR_COMMAND" title="CTEST_BZR_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_BZR_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: none</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">BZRUpdateOptions</code></dt><dd>Command-line options to the <code class="docutils literal notranslate">BZRCommand</code> when updating the source.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_BZR_UPDATE_OPTIONS.html#variable:CTEST_BZR_UPDATE_OPTIONS" title="CTEST_BZR_UPDATE_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_BZR_UPDATE_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: none</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">CVSCommand</code></dt><dd><code class="docutils literal notranslate">cvs</code> command-line tool to use if source tree is managed by CVS.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_CVS_COMMAND.html#variable:CTEST_CVS_COMMAND" title="CTEST_CVS_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_CVS_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CVSCOMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">CVSUpdateOptions</code></dt><dd>Command-line options to the <code class="docutils literal notranslate">CVSCommand</code> when updating the source.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_CVS_UPDATE_OPTIONS.html#variable:CTEST_CVS_UPDATE_OPTIONS" title="CTEST_CVS_UPDATE_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_CVS_UPDATE_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CVS_UPDATE_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">GITCommand</code></dt><dd><code class="docutils literal notranslate">git</code> command-line tool to use if source tree is managed by Git.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_GIT_COMMAND.html#variable:CTEST_GIT_COMMAND" title="CTEST_GIT_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_GIT_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">GITCOMMAND</code></li>
</ul>
The source tree is updated by <code class="docutils literal notranslate">git fetch</code> followed by
<code class="docutils literal notranslate">git reset --hard</code> to the <code class="docutils literal notranslate">FETCH_HEAD</code>. The result is the same
as <code class="docutils literal notranslate">git pull</code> except that any local modifications are overwritten.
Use <code class="docutils literal notranslate">GITUpdateCustom</code> to specify a different approach.
</dd>
<dt><code class="docutils literal notranslate">GITInitSubmodules</code></dt><dd>If set, CTest will update the repository's submodules before updating.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_GIT_INIT_SUBMODULES.html#variable:CTEST_GIT_INIT_SUBMODULES" title="CTEST_GIT_INIT_SUBMODULES"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_GIT_INIT_SUBMODULES</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_GIT_INIT_SUBMODULES</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">GITUpdateCustom</code></dt><dd>Specify a custom command line (as a semicolon-separated list) to run
in the source tree (Git work tree) to update it instead of running
the <code class="docutils literal notranslate">GITCommand</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_GIT_UPDATE_CUSTOM.html#variable:CTEST_GIT_UPDATE_CUSTOM" title="CTEST_GIT_UPDATE_CUSTOM"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_GIT_UPDATE_CUSTOM</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_GIT_UPDATE_CUSTOM</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">GITUpdateOptions</code></dt><dd>Command-line options to the <code class="docutils literal notranslate">GITCommand</code> when updating the source.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_GIT_UPDATE_OPTIONS.html#variable:CTEST_GIT_UPDATE_OPTIONS" title="CTEST_GIT_UPDATE_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_GIT_UPDATE_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">GIT_UPDATE_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">HGCommand</code></dt><dd><code class="docutils literal notranslate">hg</code> command-line tool to use if source tree is managed by Mercurial.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_HG_COMMAND.html#variable:CTEST_HG_COMMAND" title="CTEST_HG_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_HG_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: none</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">HGUpdateOptions</code></dt><dd>Command-line options to the <code class="docutils literal notranslate">HGCommand</code> when updating the source.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_HG_UPDATE_OPTIONS.html#variable:CTEST_HG_UPDATE_OPTIONS" title="CTEST_HG_UPDATE_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_HG_UPDATE_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: none</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">P4Client</code></dt><dd>Value of the <code class="docutils literal notranslate">-c</code> option to the <code class="docutils literal notranslate">P4Command</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_P4_CLIENT.html#variable:CTEST_P4_CLIENT" title="CTEST_P4_CLIENT"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_P4_CLIENT</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_P4_CLIENT</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">P4Command</code></dt><dd><code class="docutils literal notranslate">p4</code> command-line tool to use if source tree is managed by Perforce.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_P4_COMMAND.html#variable:CTEST_P4_COMMAND" title="CTEST_P4_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_P4_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">P4COMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">P4Options</code></dt><dd>Command-line options to the <code class="docutils literal notranslate">P4Command</code> for all invocations.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_P4_OPTIONS.html#variable:CTEST_P4_OPTIONS" title="CTEST_P4_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_P4_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_P4_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">P4UpdateCustom</code></dt><dd>Specify a custom command line (as a semicolon-separated list) to run
in the source tree (Perforce tree) to update it instead of running
the <code class="docutils literal notranslate">P4Command</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_P4_UPDATE_CUSTOM</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">P4UpdateOptions</code></dt><dd>Command-line options to the <code class="docutils literal notranslate">P4Command</code> when updating the source.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_P4_UPDATE_OPTIONS.html#variable:CTEST_P4_UPDATE_OPTIONS" title="CTEST_P4_UPDATE_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_P4_UPDATE_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_P4_UPDATE_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">SVNCommand</code></dt><dd><code class="docutils literal notranslate">svn</code> command-line tool to use if source tree is managed by Subversion.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_SVN_COMMAND.html#variable:CTEST_SVN_COMMAND" title="CTEST_SVN_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_SVN_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">SVNCOMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">SVNOptions</code></dt><dd>Command-line options to the <code class="docutils literal notranslate">SVNCommand</code> for all invocations.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_SVN_OPTIONS.html#variable:CTEST_SVN_OPTIONS" title="CTEST_SVN_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_SVN_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_SVN_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">SVNUpdateOptions</code></dt><dd>Command-line options to the <code class="docutils literal notranslate">SVNCommand</code> when updating the source.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_SVN_UPDATE_OPTIONS.html#variable:CTEST_SVN_UPDATE_OPTIONS" title="CTEST_SVN_UPDATE_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_SVN_UPDATE_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">SVN_UPDATE_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">UpdateCommand</code></dt><dd>Specify the version-control command-line tool to use without
detecting the VCS that manages the source tree.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_UPDATE_COMMAND.html#variable:CTEST_UPDATE_COMMAND" title="CTEST_UPDATE_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_UPDATE_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">&lt;VCS&gt;COMMAND</code>
when <code class="docutils literal notranslate">UPDATE_TYPE</code> is <code class="docutils literal notranslate">&lt;vcs&gt;</code>, else <code class="docutils literal notranslate">UPDATE_COMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">UpdateOptions</code></dt><dd>Command-line options to the <code class="docutils literal notranslate">UpdateCommand</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_UPDATE_OPTIONS.html#variable:CTEST_UPDATE_OPTIONS" title="CTEST_UPDATE_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_UPDATE_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">&lt;VCS&gt;_UPDATE_OPTIONS</code>
when <code class="docutils literal notranslate">UPDATE_TYPE</code> is <code class="docutils literal notranslate">&lt;vcs&gt;</code>, else <code class="docutils literal notranslate">UPDATE_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">UpdateType</code></dt><dd>Specify the version-control system that manages the source
tree if it cannot be detected automatically.
The value may be <code class="docutils literal notranslate">bzr</code>, <code class="docutils literal notranslate">cvs</code>, <code class="docutils literal notranslate">git</code>, <code class="docutils literal notranslate">hg</code>,
<code class="docutils literal notranslate">p4</code>, or <code class="docutils literal notranslate">svn</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none, detected from source tree</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">UPDATE_TYPE</code> if set,
else <code class="docutils literal notranslate">CTEST_UPDATE_TYPE</code></li>
</ul>
</dd>
</dl>
<dl class="simple" id="updateversiononly">
<dt><code class="docutils literal notranslate">UpdateVersionOnly</code></dt><dd>Specify that you want the version control update command to only
discover the current version that is checked out, and not to update
to a different version.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_UPDATE_VERSION_ONLY.html#variable:CTEST_UPDATE_VERSION_ONLY" title="CTEST_UPDATE_VERSION_ONLY"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_UPDATE_VERSION_ONLY</code></a></li>
</ul>
</dd>
</dl>
<dl id="updateversionoverride">
<dt><code class="docutils literal notranslate">UpdateVersionOverride</code></dt><dd>Specify the current version of your source tree.
When this variable is set to a non-empty string, CTest will report the value
you specified rather than using the update command to discover the current
version that is checked out. Use of this variable supersedes
<code class="docutils literal notranslate">UpdateVersionOnly</code>. Like <code class="docutils literal notranslate">UpdateVersionOnly</code>, using this variable tells
CTest not to update the source tree to a different version.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_UPDATE_VERSION_OVERRIDE.html#variable:CTEST_UPDATE_VERSION_OVERRIDE" title="CTEST_UPDATE_VERSION_OVERRIDE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_UPDATE_VERSION_OVERRIDE</code></a></li>
</ul>
</dd>
</dl>
Additional configuration settings include:
<dl class="simple">
<dt><code class="docutils literal notranslate">NightlyStartTime</code></dt><dd>In the <code class="docutils literal notranslate">Nightly</code> dashboard mode, specify the &quot;nightly start time&quot;.
With centralized version control systems (<code class="docutils literal notranslate">cvs</code> and <code class="docutils literal notranslate">svn</code>),
the <code class="docutils literal notranslate">Update</code> step checks out the version of the software as of
this time so that multiple clients choose a common version to test.
This is not well-defined in distributed version-control systems so
the setting is ignored.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_NIGHTLY_START_TIME.html#variable:CTEST_NIGHTLY_START_TIME" title="CTEST_NIGHTLY_START_TIME"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_NIGHTLY_START_TIME</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">NIGHTLY_START_TIME</code> if set,
else <code class="docutils literal notranslate">CTEST_NIGHTLY_START_TIME</code></li>
</ul>
</dd>
</dl>
</section>
<section id="ctest-configure-step">
<h3><a class="toc-backref" href="#id31" role="doc-backlink">CTest Configure Step</a><a class="headerlink" href="#ctest-configure-step" title="Permalink to this heading">¶</a></h3>
In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <a class="reference internal" href="../command/ctest_configure.html#command:ctest_configure" title="ctest_configure"><code class="xref cmake cmake-command docutils literal notranslate">ctest_configure()</code></a> command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
<dl>
<dt><code class="docutils literal notranslate">ConfigureCommand</code></dt><dd>Command-line to launch the software configuration process.
It will be executed in the location specified by the
<code class="docutils literal notranslate">BuildDirectory</code> setting.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_CONFIGURE_COMMAND.html#variable:CTEST_CONFIGURE_COMMAND" title="CTEST_CONFIGURE_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_CONFIGURE_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <a class="reference internal" href="../variable/CMAKE_COMMAND.html#variable:CMAKE_COMMAND" title="CMAKE_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_COMMAND</code></a>
followed by <a class="reference internal" href="../variable/PROJECT_SOURCE_DIR.html#variable:PROJECT_SOURCE_DIR" title="PROJECT_SOURCE_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">PROJECT_SOURCE_DIR</code></a></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">LabelsForSubprojects</code></dt><dd>Specify a semicolon-separated list of labels that will be treated as
subprojects. This mapping will be passed on to CDash when configure, test or
build results are submitted.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_LABELS_FOR_SUBPROJECTS.html#variable:CTEST_LABELS_FOR_SUBPROJECTS" title="CTEST_LABELS_FOR_SUBPROJECTS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_LABELS_FOR_SUBPROJECTS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_LABELS_FOR_SUBPROJECTS</code></li>
</ul>
See <a class="reference internal" href="#label-and-subproject-summary">Label and Subproject Summary</a>.
</dd>
</dl>
</section>
<section id="ctest-build-step">
<h3><a class="toc-backref" href="#id32" role="doc-backlink">CTest Build Step</a><a class="headerlink" href="#ctest-build-step" title="Permalink to this heading">¶</a></h3>
In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <a class="reference internal" href="../command/ctest_build.html#command:ctest_build" title="ctest_build"><code class="xref cmake cmake-command docutils literal notranslate">ctest_build()</code></a> command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
<dl>
<dt><code class="docutils literal notranslate">DefaultCTestConfigurationType</code></dt><dd>When the build system to be launched allows build-time selection
of the configuration (e.g. <code class="docutils literal notranslate">Debug</code>, <code class="docutils literal notranslate">Release</code>), this specifies
the default configuration to be built when no <a class="reference internal" href="#cmdoption-ctest-C"><code class="xref std std-option docutils literal notranslate">-C</code></a>
option is given to the ctest command. The value will be substituted
into the value of <code class="docutils literal notranslate">MakeCommand</code> to replace the literal string
<code class="docutils literal notranslate">${CTEST_CONFIGURATION_TYPE}</code> if it appears.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_CONFIGURATION_TYPE.html#variable:CTEST_CONFIGURATION_TYPE" title="CTEST_CONFIGURATION_TYPE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_CONFIGURATION_TYPE</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">DEFAULT_CTEST_CONFIGURATION_TYPE</code>,
initialized by the <a class="reference internal" href="../envvar/CMAKE_CONFIG_TYPE.html#envvar:CMAKE_CONFIG_TYPE" title="CMAKE_CONFIG_TYPE"><code class="xref cmake cmake-envvar docutils literal notranslate">CMAKE_CONFIG_TYPE</code></a> environment variable</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">LabelsForSubprojects</code></dt><dd>Specify a semicolon-separated list of labels that will be treated as
subprojects. This mapping will be passed on to CDash when configure, test or
build results are submitted.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_LABELS_FOR_SUBPROJECTS.html#variable:CTEST_LABELS_FOR_SUBPROJECTS" title="CTEST_LABELS_FOR_SUBPROJECTS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_LABELS_FOR_SUBPROJECTS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_LABELS_FOR_SUBPROJECTS</code></li>
</ul>
See <a class="reference internal" href="#label-and-subproject-summary">Label and Subproject Summary</a>.
</dd>
<dt><code class="docutils literal notranslate">MakeCommand</code></dt><dd>Command-line to launch the software build process.
It will be executed in the location specified by the
<code class="docutils literal notranslate">BuildDirectory</code> setting.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_BUILD_COMMAND.html#variable:CTEST_BUILD_COMMAND" title="CTEST_BUILD_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_BUILD_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">MAKECOMMAND</code>,
initialized by the <a class="reference internal" href="../command/build_command.html#command:build_command" title="build_command"><code class="xref cmake cmake-command docutils literal notranslate">build_command()</code></a> command</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">UseLaunchers</code></dt><dd>For build trees generated by CMake using one of the
<a class="reference internal" href="cmake-generators.7.html#makefile-generators">Makefile Generators</a> or the <a class="reference internal" href="../generator/Ninja.html#generator:Ninja" title="Ninja"><code class="xref cmake cmake-generator docutils literal notranslate">Ninja</code></a>
generator, specify whether the
<code class="docutils literal notranslate">CTEST_USE_LAUNCHERS</code> feature is enabled by the
<a class="reference internal" href="../module/CTestUseLaunchers.html#module:CTestUseLaunchers" title="CTestUseLaunchers"><code class="xref cmake cmake-module docutils literal notranslate">CTestUseLaunchers</code></a> module (also included by the
<a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module). When enabled, the generated build
system wraps each invocation of the compiler, linker, or
custom command line with a &quot;launcher&quot; that communicates
with CTest via environment variables and files to report
granular build warning and error information. Otherwise,
CTest must &quot;scrape&quot; the build output log for diagnostics.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_USE_LAUNCHERS.html#variable:CTEST_USE_LAUNCHERS" title="CTEST_USE_LAUNCHERS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_USE_LAUNCHERS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_USE_LAUNCHERS</code></li>
</ul>
</dd>
</dl>
</section>
<section id="ctest-test-step">
<h3><a class="toc-backref" href="#id33" role="doc-backlink">CTest Test Step</a><a class="headerlink" href="#ctest-test-step" title="Permalink to this heading">¶</a></h3>
In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <a class="reference internal" href="../command/ctest_test.html#command:ctest_test" title="ctest_test"><code class="xref cmake cmake-command docutils literal notranslate">ctest_test()</code></a> command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
<dl>
<dt><code class="docutils literal notranslate">ResourceSpecFile</code></dt><dd>Specify a
<a class="reference internal" href="#ctest-resource-specification-file">resource specification file</a>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_RESOURCE_SPEC_FILE.html#variable:CTEST_RESOURCE_SPEC_FILE" title="CTEST_RESOURCE_SPEC_FILE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_RESOURCE_SPEC_FILE</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_RESOURCE_SPEC_FILE</code></li>
</ul>
See <a class="reference internal" href="#ctest-resource-allocation">Resource Allocation</a> for more information.
</dd>
<dt><code class="docutils literal notranslate">LabelsForSubprojects</code></dt><dd>Specify a semicolon-separated list of labels that will be treated as
subprojects. This mapping will be passed on to CDash when configure, test or
build results are submitted.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_LABELS_FOR_SUBPROJECTS.html#variable:CTEST_LABELS_FOR_SUBPROJECTS" title="CTEST_LABELS_FOR_SUBPROJECTS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_LABELS_FOR_SUBPROJECTS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_LABELS_FOR_SUBPROJECTS</code></li>
</ul>
See <a class="reference internal" href="#label-and-subproject-summary">Label and Subproject Summary</a>.
</dd>
<dt><code class="docutils literal notranslate">TestLoad</code></dt><dd>While running tests in parallel (e.g. with <a class="reference internal" href="#cmdoption-ctest-j"><code class="xref std std-option docutils literal notranslate">-j</code></a>),
try not to start tests when they may cause the CPU load to pass above
a given threshold.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_TEST_LOAD.html#variable:CTEST_TEST_LOAD" title="CTEST_TEST_LOAD"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_TEST_LOAD</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_TEST_LOAD</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">TimeOut</code></dt><dd>The default timeout for each test if not specified by the
<a class="reference internal" href="../prop_test/TIMEOUT.html#prop_test:TIMEOUT" title="TIMEOUT"><code class="xref cmake cmake-prop_test docutils literal notranslate">TIMEOUT</code></a> test property.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_TEST_TIMEOUT.html#variable:CTEST_TEST_TIMEOUT" title="CTEST_TEST_TIMEOUT"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_TEST_TIMEOUT</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">DART_TESTING_TIMEOUT</code></li>
</ul>
</dd>
</dl>
To report extra test values to CDash, see <a class="reference internal" href="../command/ctest_test.html#additional-test-measurements">Additional Test Measurements</a>.
</section>
<section id="ctest-coverage-step">
<h3><a class="toc-backref" href="#id34" role="doc-backlink">CTest Coverage Step</a><a class="headerlink" href="#ctest-coverage-step" title="Permalink to this heading">¶</a></h3>
In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <a class="reference internal" href="../command/ctest_coverage.html#command:ctest_coverage" title="ctest_coverage"><code class="xref cmake cmake-command docutils literal notranslate">ctest_coverage()</code></a> command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
<dl>
<dt><code class="docutils literal notranslate">CoverageCommand</code></dt><dd>Command-line tool to perform software coverage analysis.
It will be executed in the location specified by the
<code class="docutils literal notranslate">BuildDirectory</code> setting.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_COVERAGE_COMMAND.html#variable:CTEST_COVERAGE_COMMAND" title="CTEST_COVERAGE_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_COVERAGE_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">COVERAGE_COMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">CoverageExtraFlags</code></dt><dd>Specify command-line options to the <code class="docutils literal notranslate">CoverageCommand</code> tool.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_COVERAGE_EXTRA_FLAGS.html#variable:CTEST_COVERAGE_EXTRA_FLAGS" title="CTEST_COVERAGE_EXTRA_FLAGS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_COVERAGE_EXTRA_FLAGS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">COVERAGE_EXTRA_FLAGS</code></li>
</ul>
These options are the first arguments passed to <code class="docutils literal notranslate">CoverageCommand</code>.
</dd>
</dl>
</section>
<section id="ctest-memcheck-step">
<h3><a class="toc-backref" href="#id35" role="doc-backlink">CTest MemCheck Step</a><a class="headerlink" href="#ctest-memcheck-step" title="Permalink to this heading">¶</a></h3>
In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <a class="reference internal" href="../command/ctest_memcheck.html#command:ctest_memcheck" title="ctest_memcheck"><code class="xref cmake cmake-command docutils literal notranslate">ctest_memcheck()</code></a> command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
<dl class="simple">
<dt><code class="docutils literal notranslate">MemoryCheckCommand</code></dt><dd>Command-line tool to perform dynamic analysis. Test command lines
will be launched through this tool.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_MEMORYCHECK_COMMAND.html#variable:CTEST_MEMORYCHECK_COMMAND" title="CTEST_MEMORYCHECK_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_MEMORYCHECK_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">MEMORYCHECK_COMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">MemoryCheckCommandOptions</code></dt><dd>Specify command-line options to the <code class="docutils literal notranslate">MemoryCheckCommand</code> tool.
They will be placed prior to the test command line.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_MEMORYCHECK_COMMAND_OPTIONS.html#variable:CTEST_MEMORYCHECK_COMMAND_OPTIONS" title="CTEST_MEMORYCHECK_COMMAND_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_MEMORYCHECK_COMMAND_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">MEMORYCHECK_COMMAND_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">MemoryCheckType</code></dt><dd>Specify the type of memory checking to perform.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_MEMORYCHECK_TYPE.html#variable:CTEST_MEMORYCHECK_TYPE" title="CTEST_MEMORYCHECK_TYPE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_MEMORYCHECK_TYPE</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">MEMORYCHECK_TYPE</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">MemoryCheckSanitizerOptions</code></dt><dd>Specify options to sanitizers when running with a sanitize-enabled build.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_MEMORYCHECK_SANITIZER_OPTIONS.html#variable:CTEST_MEMORYCHECK_SANITIZER_OPTIONS" title="CTEST_MEMORYCHECK_SANITIZER_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_MEMORYCHECK_SANITIZER_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">MEMORYCHECK_SANITIZER_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">MemoryCheckSuppressionFile</code></dt><dd>Specify a file containing suppression rules for the
<code class="docutils literal notranslate">MemoryCheckCommand</code> tool. It will be passed with options
appropriate to the tool.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_MEMORYCHECK_SUPPRESSIONS_FILE.html#variable:CTEST_MEMORYCHECK_SUPPRESSIONS_FILE" title="CTEST_MEMORYCHECK_SUPPRESSIONS_FILE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_MEMORYCHECK_SUPPRESSIONS_FILE</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">MEMORYCHECK_SUPPRESSIONS_FILE</code></li>
</ul>
</dd>
</dl>
Additional configuration settings include:
<dl class="simple">
<dt><code class="docutils literal notranslate">BoundsCheckerCommand</code></dt><dd>Specify a <code class="docutils literal notranslate">MemoryCheckCommand</code> that is known to be command-line
compatible with Bounds Checker.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: none</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">PurifyCommand</code></dt><dd>Specify a <code class="docutils literal notranslate">MemoryCheckCommand</code> that is known to be command-line
compatible with Purify.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">PURIFYCOMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">ValgrindCommand</code></dt><dd>Specify a <code class="docutils literal notranslate">MemoryCheckCommand</code> that is known to be command-line
compatible with Valgrind.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">VALGRIND_COMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">ValgrindCommandOptions</code></dt><dd>Specify command-line options to the <code class="docutils literal notranslate">ValgrindCommand</code> tool.
They will be placed prior to the test command line.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">VALGRIND_COMMAND_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">DrMemoryCommand</code></dt><dd>Specify a <code class="docutils literal notranslate">MemoryCheckCommand</code> that is known to be a command-line
compatible with DrMemory.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">DRMEMORY_COMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">DrMemoryCommandOptions</code></dt><dd>Specify command-line options to the <code class="docutils literal notranslate">DrMemoryCommand</code> tool.
They will be placed prior to the test command line.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">DRMEMORY_COMMAND_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">CudaSanitizerCommand</code></dt><dd>Specify a <code class="docutils literal notranslate">MemoryCheckCommand</code> that is known to be a command-line
compatible with cuda-memcheck or compute-sanitizer.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CUDA_SANITIZER_COMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">CudaSanitizerCommandOptions</code></dt><dd>Specify command-line options to the <code class="docutils literal notranslate">CudaSanitizerCommand</code> tool.
They will be placed prior to the test command line.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CUDA_SANITIZER_COMMAND_OPTIONS</code></li>
</ul>
</dd>
</dl>
</section>
<section id="ctest-submit-step">
<h3><a class="toc-backref" href="#id36" role="doc-backlink">CTest Submit Step</a><a class="headerlink" href="#ctest-submit-step" title="Permalink to this heading">¶</a></h3>
In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <a class="reference internal" href="../command/ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal notranslate">ctest_submit()</code></a> command runs this step.
Arguments to the command may specify some of the step settings.
Configuration settings include:
<dl class="simple">
<dt><code class="docutils literal notranslate">BuildName</code></dt><dd>Describe the dashboard client platform with a short string.
(Operating system, compiler, etc.)
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_BUILD_NAME.html#variable:CTEST_BUILD_NAME" title="CTEST_BUILD_NAME"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_BUILD_NAME</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">BUILDNAME</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">CDashVersion</code></dt><dd>Legacy option. Not used.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none, detected from server</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_CDASH_VERSION</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">CTestSubmitRetryCount</code></dt><dd>Specify a number of attempts to retry submission on network failure.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none,
use the <a class="reference internal" href="../command/ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal notranslate">ctest_submit()</code></a> <code class="docutils literal notranslate">RETRY_COUNT</code> option.</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_SUBMIT_RETRY_COUNT</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">CTestSubmitRetryDelay</code></dt><dd>Specify a delay before retrying submission on network failure.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none,
use the <a class="reference internal" href="../command/ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal notranslate">ctest_submit()</code></a> <code class="docutils literal notranslate">RETRY_DELAY</code> option.</li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_SUBMIT_RETRY_DELAY</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">CurlOptions</code></dt><dd>Specify a semicolon-separated list of options to control the
Curl library that CTest uses internally to connect to the
server. Possible options are <code class="docutils literal notranslate">CURLOPT_SSL_VERIFYPEER_OFF</code>
and <code class="docutils literal notranslate">CURLOPT_SSL_VERIFYHOST_OFF</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_CURL_OPTIONS.html#variable:CTEST_CURL_OPTIONS" title="CTEST_CURL_OPTIONS"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_CURL_OPTIONS</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_CURL_OPTIONS</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">DropLocation</code></dt><dd>Legacy option. When <code class="docutils literal notranslate">SubmitURL</code> is not set, it is constructed from
<code class="docutils literal notranslate">DropMethod</code>, <code class="docutils literal notranslate">DropSiteUser</code>, <code class="docutils literal notranslate">DropSitePassword</code>, <code class="docutils literal notranslate">DropSite</code>, and
<code class="docutils literal notranslate">DropLocation</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_DROP_LOCATION.html#variable:CTEST_DROP_LOCATION" title="CTEST_DROP_LOCATION"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_DROP_LOCATION</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">DROP_LOCATION</code> if set,
else <code class="docutils literal notranslate">CTEST_DROP_LOCATION</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">DropMethod</code></dt><dd>Legacy option. When <code class="docutils literal notranslate">SubmitURL</code> is not set, it is constructed from
<code class="docutils literal notranslate">DropMethod</code>, <code class="docutils literal notranslate">DropSiteUser</code>, <code class="docutils literal notranslate">DropSitePassword</code>, <code class="docutils literal notranslate">DropSite</code>, and
<code class="docutils literal notranslate">DropLocation</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_DROP_METHOD.html#variable:CTEST_DROP_METHOD" title="CTEST_DROP_METHOD"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_DROP_METHOD</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">DROP_METHOD</code> if set,
else <code class="docutils literal notranslate">CTEST_DROP_METHOD</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">DropSite</code></dt><dd>Legacy option. When <code class="docutils literal notranslate">SubmitURL</code> is not set, it is constructed from
<code class="docutils literal notranslate">DropMethod</code>, <code class="docutils literal notranslate">DropSiteUser</code>, <code class="docutils literal notranslate">DropSitePassword</code>, <code class="docutils literal notranslate">DropSite</code>, and
<code class="docutils literal notranslate">DropLocation</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_DROP_SITE.html#variable:CTEST_DROP_SITE" title="CTEST_DROP_SITE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_DROP_SITE</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">DROP_SITE</code> if set,
else <code class="docutils literal notranslate">CTEST_DROP_SITE</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">DropSitePassword</code></dt><dd>Legacy option. When <code class="docutils literal notranslate">SubmitURL</code> is not set, it is constructed from
<code class="docutils literal notranslate">DropMethod</code>, <code class="docutils literal notranslate">DropSiteUser</code>, <code class="docutils literal notranslate">DropSitePassword</code>, <code class="docutils literal notranslate">DropSite</code>, and
<code class="docutils literal notranslate">DropLocation</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_DROP_SITE_PASSWORD.html#variable:CTEST_DROP_SITE_PASSWORD" title="CTEST_DROP_SITE_PASSWORD"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_DROP_SITE_PASSWORD</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">DROP_SITE_PASSWORD</code> if set,
else <code class="docutils literal notranslate">CTEST_DROP_SITE_PASWORD</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">DropSiteUser</code></dt><dd>Legacy option. When <code class="docutils literal notranslate">SubmitURL</code> is not set, it is constructed from
<code class="docutils literal notranslate">DropMethod</code>, <code class="docutils literal notranslate">DropSiteUser</code>, <code class="docutils literal notranslate">DropSitePassword</code>, <code class="docutils literal notranslate">DropSite</code>, and
<code class="docutils literal notranslate">DropLocation</code>.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_DROP_SITE_USER.html#variable:CTEST_DROP_SITE_USER" title="CTEST_DROP_SITE_USER"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_DROP_SITE_USER</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">DROP_SITE_USER</code> if set,
else <code class="docutils literal notranslate">CTEST_DROP_SITE_USER</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">IsCDash</code></dt><dd>Legacy option. Not used.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_DROP_SITE_CDASH.html#variable:CTEST_DROP_SITE_CDASH" title="CTEST_DROP_SITE_CDASH"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_DROP_SITE_CDASH</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_DROP_SITE_CDASH</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">ScpCommand</code></dt><dd>Legacy option. Not used.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_SCP_COMMAND.html#variable:CTEST_SCP_COMMAND" title="CTEST_SCP_COMMAND"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_SCP_COMMAND</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">SCPCOMMAND</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">Site</code></dt><dd>Describe the dashboard client host site with a short string.
(Hostname, domain, etc.)
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_SITE.html#variable:CTEST_SITE" title="CTEST_SITE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_SITE</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">SITE</code>,
initialized by the <a class="reference internal" href="../command/site_name.html#command:site_name" title="site_name"><code class="xref cmake cmake-command docutils literal notranslate">site_name()</code></a> command</li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">SubmitURL</code></dt><dd>The <code class="docutils literal notranslate">http</code> or <code class="docutils literal notranslate">https</code> URL of the dashboard server to send the submission
to.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_SUBMIT_URL.html#variable:CTEST_SUBMIT_URL" title="CTEST_SUBMIT_URL"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_SUBMIT_URL</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">SUBMIT_URL</code> if set,
else <code class="docutils literal notranslate">CTEST_SUBMIT_URL</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">SubmitInactivityTimeout</code></dt><dd>The time to wait for the submission after which it is canceled
if not completed. Specify a zero value to disable timeout.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_SUBMIT_INACTIVITY_TIMEOUT.html#variable:CTEST_SUBMIT_INACTIVITY_TIMEOUT" title="CTEST_SUBMIT_INACTIVITY_TIMEOUT"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_SUBMIT_INACTIVITY_TIMEOUT</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">CTEST_SUBMIT_INACTIVITY_TIMEOUT</code></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate">TriggerSite</code></dt><dd>Legacy option. Not used.
<ul class="simple">
<li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <a class="reference internal" href="../variable/CTEST_TRIGGER_SITE.html#variable:CTEST_TRIGGER_SITE" title="CTEST_TRIGGER_SITE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_TRIGGER_SITE</code></a></li>
<li><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal notranslate">CTest</code></a> module variable: <code class="docutils literal notranslate">TRIGGER_SITE</code> if set,
else <code class="docutils literal notranslate">CTEST_TRIGGER_SITE</code></li>
</ul>
</dd>
</dl>
</section>
</section>
<section id="show-as-json-object-model">
<h2><a class="toc-backref" href="#id37" role="doc-backlink">Show as JSON Object Model</a><a class="headerlink" href="#show-as-json-object-model" title="Permalink to this heading">¶</a></h2>
<div class="versionadded">
New in version 3.14.
</div>
When the <code class="docutils literal notranslate">--show-only=json-v1</code> command line option is given, the test
information is output in JSON format. Version 1.0 of the JSON object
model is defined as follows:
<dl>
<dt><code class="docutils literal notranslate">kind</code></dt><dd>The string &quot;ctestInfo&quot;.
</dd>
<dt><code class="docutils literal notranslate">version</code></dt><dd>A JSON object specifying the version components. Its members are
<dl class="simple">
<dt><code class="docutils literal notranslate">major</code></dt><dd>A non-negative integer specifying the major version component.
</dd>
<dt><code class="docutils literal notranslate">minor</code></dt><dd>A non-negative integer specifying the minor version component.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">backtraceGraph</code></dt><dd>JSON object representing backtrace information with the
following members:
<dl>
<dt><code class="docutils literal notranslate">commands</code></dt><dd>List of command names.
</dd>
<dt><code class="docutils literal notranslate">files</code></dt><dd>List of file names.
</dd>
<dt><code class="docutils literal notranslate">nodes</code></dt><dd>List of node JSON objects with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">command</code></dt><dd>Index into the <code class="docutils literal notranslate">commands</code> member of the <code class="docutils literal notranslate">backtraceGraph</code>.
</dd>
<dt><code class="docutils literal notranslate">file</code></dt><dd>Index into the <code class="docutils literal notranslate">files</code> member of the <code class="docutils literal notranslate">backtraceGraph</code>.
</dd>
<dt><code class="docutils literal notranslate">line</code></dt><dd>Line number in the file where the backtrace was added.
</dd>
<dt><code class="docutils literal notranslate">parent</code></dt><dd>Index into the <code class="docutils literal notranslate">nodes</code> member of the <code class="docutils literal notranslate">backtraceGraph</code>
representing the parent in the graph.
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">tests</code></dt><dd>A JSON array listing information about each test. Each entry
is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">name</code></dt><dd>Test name.
</dd>
<dt><code class="docutils literal notranslate">config</code></dt><dd>Configuration that the test can run on.
Empty string means any config.
</dd>
<dt><code class="docutils literal notranslate">command</code></dt><dd>List where the first element is the test command and the
remaining elements are the command arguments.
</dd>
<dt><code class="docutils literal notranslate">backtrace</code></dt><dd>Index into the <code class="docutils literal notranslate">nodes</code> member of the <code class="docutils literal notranslate">backtraceGraph</code>.
</dd>
<dt><code class="docutils literal notranslate">properties</code></dt><dd>Test properties.
Can contain keys for each of the supported test properties.
</dd>
</dl>
</dd>
</dl>
</section>
<section id="resource-allocation">
<h2><a class="toc-backref" href="#id38" role="doc-backlink">Resource Allocation</a><a class="headerlink" href="#resource-allocation" title="Permalink to this heading">¶</a></h2>
CTest provides a mechanism for tests to specify the resources that they need
in a fine-grained way, and for users to specify the resources available on
the running machine. This allows CTest to internally keep track of which
resources are in use and which are free, scheduling tests in a way that
prevents them from trying to claim resources that are not available.
When the resource allocation feature is used, CTest will not oversubscribe
resources. For example, if a resource has 8 slots, CTest will not run tests
that collectively use more than 8 slots at a time. This has the effect of
limiting how many tests can run at any given time, even if a high <code class="docutils literal notranslate">-j</code>
argument is used, if those tests all use some slots from the same resource.
In addition, it means that a single test that uses more of a resource than is
available on a machine will not run at all (and will be reported as
<code class="docutils literal notranslate">Not Run</code>).
A common use case for this feature is for tests that require the use of a GPU.
Multiple tests can simultaneously allocate memory from a GPU, but if too many
tests try to do this at once, some of them will fail to allocate, resulting in
a failed test, even though the test would have succeeded if it had the memory
it needed. By using the resource allocation feature, each test can specify how
much memory it requires from a GPU, allowing CTest to schedule tests in a way
that running several of these tests at once does not exhaust the GPU's memory
pool.
Please note that CTest has no concept of what a GPU is or how much memory it
has, nor does it have any way of communicating with a GPU to retrieve this
information or perform any memory management. CTest simply keeps track of a
list of abstract resource types, each of which has a certain number of slots
available for tests to use. Each test specifies the number of slots that it
requires from a certain resource, and CTest then schedules them in a way that
prevents the total number of slots in use from exceeding the listed capacity.
When a test is executed, and slots from a resource are allocated to that test,
tests may assume that they have exclusive use of those slots for the duration
of the test's process.
The CTest resource allocation feature consists of two inputs:
<ul class="simple">
<li>The <a class="reference internal" href="#ctest-resource-specification-file">resource specification file</a>,
described below, which describes the resources available on the system.</li>
<li>The <a class="reference internal" href="../prop_test/RESOURCE_GROUPS.html#prop_test:RESOURCE_GROUPS" title="RESOURCE_GROUPS"><code class="xref cmake cmake-prop_test docutils literal notranslate">RESOURCE_GROUPS</code></a> property of tests, which describes the
resources required by the test.</li>
</ul>
When CTest runs a test, the resources allocated to that test are passed in the
form of a set of
<a class="reference internal" href="#ctest-resource-environment-variables">environment variables</a> as
described below. Using this information to decide which resource to connect to
is left to the test writer.
The <code class="docutils literal notranslate">RESOURCE_GROUPS</code> property tells CTest what resources a test expects
to use grouped in a way meaningful to the test. The test itself must read
the <a class="reference internal" href="#ctest-resource-environment-variables">environment variables</a> to
determine which resources have been allocated to each group. For example,
each group may correspond to a process the test will spawn when executed.
Note that even if a test specifies a <code class="docutils literal notranslate">RESOURCE_GROUPS</code> property, it is still
possible for that to test to run without any resource allocation (and without
the corresponding
<a class="reference internal" href="#ctest-resource-environment-variables">environment variables</a>)
if the user does not pass a resource specification file. Passing this file,
either through the <code class="docutils literal notranslate">--resource-spec-file</code> command-line argument or the
<code class="docutils literal notranslate">RESOURCE_SPEC_FILE</code> argument to <a class="reference internal" href="../command/ctest_test.html#command:ctest_test" title="ctest_test"><code class="xref cmake cmake-command docutils literal notranslate">ctest_test()</code></a>, is what activates the
resource allocation feature. Tests should check the
<code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_COUNT</code> environment variable to find out whether or not
resource allocation is activated. This variable will always (and only) be
defined if resource allocation is activated. If resource allocation is not
activated, then the <code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_COUNT</code> variable will not exist,
even if it exists for the parent ctest process. If a test absolutely must
have resource allocation, then it can return a failing exit code or use the
<a class="reference internal" href="../prop_test/SKIP_RETURN_CODE.html#prop_test:SKIP_RETURN_CODE" title="SKIP_RETURN_CODE"><code class="xref cmake cmake-prop_test docutils literal notranslate">SKIP_RETURN_CODE</code></a> or <a class="reference internal" href="../prop_test/SKIP_REGULAR_EXPRESSION.html#prop_test:SKIP_REGULAR_EXPRESSION" title="SKIP_REGULAR_EXPRESSION"><code class="xref cmake cmake-prop_test docutils literal notranslate">SKIP_REGULAR_EXPRESSION</code></a>
properties to indicate a skipped test.
<section id="resource-specification-file">
<h3><a class="toc-backref" href="#id39" role="doc-backlink">Resource Specification File</a><a class="headerlink" href="#resource-specification-file" title="Permalink to this heading">¶</a></h3>
The resource specification file is a JSON file which is passed to CTest, either
on the command line as <a class="reference internal" href="#cmdoption-ctest-resource-spec-file"><code class="xref std std-option docutils literal notranslate">ctest --resource-spec-file</code></a>, or as the
<code class="docutils literal notranslate">RESOURCE_SPEC_FILE</code> argument of <a class="reference internal" href="../command/ctest_test.html#command:ctest_test" title="ctest_test"><code class="xref cmake cmake-command docutils literal notranslate">ctest_test()</code></a>. If a dashboard script
is used and <code class="docutils literal notranslate">RESOURCE_SPEC_FILE</code> is not specified, the value of
<a class="reference internal" href="../variable/CTEST_RESOURCE_SPEC_FILE.html#variable:CTEST_RESOURCE_SPEC_FILE" title="CTEST_RESOURCE_SPEC_FILE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_RESOURCE_SPEC_FILE</code></a> in the dashboard script is used instead.
If <a class="reference internal" href="#cmdoption-ctest-resource-spec-file"><code class="xref std std-option docutils literal notranslate">--resource-spec-file</code></a>, <code class="docutils literal notranslate">RESOURCE_SPEC_FILE</code>,
and <a class="reference internal" href="../variable/CTEST_RESOURCE_SPEC_FILE.html#variable:CTEST_RESOURCE_SPEC_FILE" title="CTEST_RESOURCE_SPEC_FILE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_RESOURCE_SPEC_FILE</code></a> in the dashboard script are not specified,
the value of <a class="reference internal" href="../variable/CTEST_RESOURCE_SPEC_FILE.html#variable:CTEST_RESOURCE_SPEC_FILE" title="CTEST_RESOURCE_SPEC_FILE"><code class="xref cmake cmake-variable docutils literal notranslate">CTEST_RESOURCE_SPEC_FILE</code></a> in the CMake build is used
instead. If none of these are specified, no resource spec file is used.
The resource specification file must be a JSON object. All examples in this
document assume the following resource specification file:
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;version&quot;: {
 &quot;major&quot;: 1,
 &quot;minor&quot;: 0
 },
 &quot;local&quot;: [
 {
 &quot;gpus&quot;: [
 {
 &quot;id&quot;: &quot;0&quot;,
 &quot;slots&quot;: 2
 },
 {
 &quot;id&quot;: &quot;1&quot;,
 &quot;slots&quot;: 4
 },
 {
 &quot;id&quot;: &quot;2&quot;,
 &quot;slots&quot;: 2
 },
 {
 &quot;id&quot;: &quot;3&quot;
 }
 ],
 &quot;crypto_chips&quot;: [
 {
 &quot;id&quot;: &quot;card0&quot;,
 &quot;slots&quot;: 4
 }
 ]
 }
 ]
}
</pre></div>
</div>
The members are:
<dl>
<dt><code class="docutils literal notranslate">version</code></dt><dd>An object containing a <code class="docutils literal notranslate">major</code> integer field and a <code class="docutils literal notranslate">minor</code> integer field.
Currently, the only supported version is major <code class="docutils literal notranslate">1</code>, minor <code class="docutils literal notranslate">0</code>. Any other
value is an error.
</dd>
<dt><code class="docutils literal notranslate">local</code></dt><dd>A JSON array of resource sets present on the system. Currently, this array
is restricted to being of size 1.
Each array element is a JSON object with members whose names are equal to the
desired resource types, such as <code class="docutils literal notranslate">gpus</code>. These names must start with a
lowercase letter or an underscore, and subsequent characters can be a
lowercase letter, a digit, or an underscore. Uppercase letters are not
allowed, because certain platforms have case-insensitive environment
variables. See the <a class="reference internal" href="#environment-variables">Environment Variables</a> section below for
more information. It is recommended that the resource type name be the plural
of a noun, such as <code class="docutils literal notranslate">gpus</code> or <code class="docutils literal notranslate">crypto_chips</code> (and not <code class="docutils literal notranslate">gpu</code> or
<code class="docutils literal notranslate">crypto_chip</code>.)
Please note that the names <code class="docutils literal notranslate">gpus</code> and <code class="docutils literal notranslate">crypto_chips</code> are just examples,
and CTest does not interpret them in any way. You are free to make up any
resource type you want to meet your own requirements.
The value for each resource type is a JSON array consisting of JSON objects,
each of which describe a specific instance of the specified resource. These
objects have the following members:
<dl>
<dt><code class="docutils literal notranslate">id</code></dt><dd>A string consisting of an identifier for the resource. Each character in
the identifier can be a lowercase letter, a digit, or an underscore.
Uppercase letters are not allowed.
Identifiers must be unique within a resource type. However, they do not
have to be unique across resource types. For example, it is valid to have a
<code class="docutils literal notranslate">gpus</code> resource named <code class="docutils literal notranslate">0</code> and a <code class="docutils literal notranslate">crypto_chips</code> resource named <code class="docutils literal notranslate">0</code>,
but not two <code class="docutils literal notranslate">gpus</code> resources both named <code class="docutils literal notranslate">0</code>.
Please note that the IDs <code class="docutils literal notranslate">0</code>, <code class="docutils literal notranslate">1</code>, <code class="docutils literal notranslate">2</code>, <code class="docutils literal notranslate">3</code>, and <code class="docutils literal notranslate">card0</code> are just
examples, and CTest does not interpret them in any way. You are free to
make up any IDs you want to meet your own requirements.
</dd>
<dt><code class="docutils literal notranslate">slots</code></dt><dd>An optional unsigned number specifying the number of slots available on the
resource. For example, this could be megabytes of RAM on a GPU, or
cryptography units available on a cryptography chip. If <code class="docutils literal notranslate">slots</code> is not
specified, a default value of <code class="docutils literal notranslate">1</code> is assumed.
</dd>
</dl>
</dd>
</dl>
In the example file above, there are four GPUs with ID's 0 through 3. GPU 0 has
2 slots, GPU 1 has 4, GPU 2 has 2, and GPU 3 has a default of 1 slot. There is
also one cryptography chip with 4 slots.
</section>
<section id="resource-groups-property">
<h3><a class="toc-backref" href="#id40" role="doc-backlink"><code class="docutils literal notranslate">RESOURCE_GROUPS</code> Property</a><a class="headerlink" href="#resource-groups-property" title="Permalink to this heading">¶</a></h3>
See <a class="reference internal" href="../prop_test/RESOURCE_GROUPS.html#prop_test:RESOURCE_GROUPS" title="RESOURCE_GROUPS"><code class="xref cmake cmake-prop_test docutils literal notranslate">RESOURCE_GROUPS</code></a> for a description of this property.
</section>
<section id="environment-variables">
<h3><a class="toc-backref" href="#id41" role="doc-backlink">Environment Variables</a><a class="headerlink" href="#environment-variables" title="Permalink to this heading">¶</a></h3>
Once CTest has decided which resources to allocate to a test, it passes this
information to the test executable as a series of environment variables. For
each example below, we will assume that the test in question has a
<a class="reference internal" href="../prop_test/RESOURCE_GROUPS.html#prop_test:RESOURCE_GROUPS" title="RESOURCE_GROUPS"><code class="xref cmake cmake-prop_test docutils literal notranslate">RESOURCE_GROUPS</code></a> property of
<code class="docutils literal notranslate">2,gpus:2;gpus:4,gpus:1,crypto_chips:2</code>.
The following variables are passed to the test process:
<dl class="cmake envvar">
<dt class="sig sig-object cmake" id="envvar:CTEST_RESOURCE_GROUP_COUNT">
CTEST_RESOURCE_GROUP_COUNT<a class="headerlink" href="#envvar:CTEST_RESOURCE_GROUP_COUNT" title="Permalink to this definition">¶</a></dt>
<dd>The total number of groups specified by the <a class="reference internal" href="../prop_test/RESOURCE_GROUPS.html#prop_test:RESOURCE_GROUPS" title="RESOURCE_GROUPS"><code class="xref cmake cmake-prop_test docutils literal notranslate">RESOURCE_GROUPS</code></a>
property. For example:
<ul class="simple">
<li><code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_COUNT=3</code></li>
</ul>
This variable will only be defined if <a class="reference internal" href="#manual:ctest(1)" title="ctest(1)"><code class="xref cmake cmake-manual docutils literal notranslate">ctest(1)</code></a> has been given a
<code class="docutils literal notranslate">--resource-spec-file</code>, or if <a class="reference internal" href="../command/ctest_test.html#command:ctest_test" title="ctest_test"><code class="xref cmake cmake-command docutils literal notranslate">ctest_test()</code></a> has been given a
<code class="docutils literal notranslate">RESOURCE_SPEC_FILE</code>. If no resource specification file has been given,
this variable will not be defined.
</dd></dl>

<dl class="cmake envvar">
<dt class="sig sig-object cmake" id="envvar:CTEST_RESOURCE_GROUP_&lt;num&gt;">
CTEST_RESOURCE_GROUP_&lt;num&gt;<a class="headerlink" href="#envvar:CTEST_RESOURCE_GROUP_<num>" title="Permalink to this definition">¶</a></dt>
<dd>The list of resource types allocated to each group, with each item
separated by a comma. <code class="docutils literal notranslate">&lt;num&gt;</code> is a number from zero to
<code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_COUNT</code> minus one. <code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_&lt;num&gt;</code>
is defined for each <code class="docutils literal notranslate">&lt;num&gt;</code> in this range. For example:
<ul class="simple">
<li><code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_0=gpus</code></li>
<li><code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_1=gpus</code></li>
<li><code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_2=crypto_chips,gpus</code></li>
</ul>
</dd></dl>

<dl class="cmake envvar">
<dt class="sig sig-object cmake" id="envvar:CTEST_RESOURCE_GROUP_&lt;num&gt;_&lt;resource-type&gt;">
CTEST_RESOURCE_GROUP_&lt;num&gt;_&lt;resource-type&gt;<a class="headerlink" href="#envvar:CTEST_RESOURCE_GROUP_<num>_<resource-type>" title="Permalink to this definition">¶</a></dt>
<dd>The list of resource IDs and number of slots from each ID allocated to each
group for a given resource type. This variable consists of a series of
pairs, each pair separated by a semicolon, and with the two items in the pair
separated by a comma. The first item in each pair is <code class="docutils literal notranslate">id:</code> followed by the
ID of a resource of type <code class="docutils literal notranslate">&lt;resource-type&gt;</code>, and the second item is
<code class="docutils literal notranslate">slots:</code> followed by the number of slots from that resource allocated to
the given group. For example:
<ul class="simple">
<li><code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_0_GPUS=id:0,slots:2</code></li>
<li><code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_1_GPUS=id:2,slots:2</code></li>
<li><code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_2_GPUS=id:1,slots:4;id:3,slots:1</code></li>
<li><code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_2_CRYPTO_CHIPS=id:card0,slots:2</code></li>
</ul>
In this example, group 0 gets 2 slots from GPU <code class="docutils literal notranslate">0</code>, group 1 gets 2 slots
from GPU <code class="docutils literal notranslate">2</code>, and group 2 gets 4 slots from GPU <code class="docutils literal notranslate">1</code>, 1 slot from GPU
<code class="docutils literal notranslate">3</code>, and 2 slots from cryptography chip <code class="docutils literal notranslate">card0</code>.
<code class="docutils literal notranslate">&lt;num&gt;</code> is a number from zero to <code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_COUNT</code> minus one.
<code class="docutils literal notranslate">&lt;resource-type&gt;</code> is the name of a resource type, converted to uppercase.
<code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_&lt;num&gt;_&lt;resource-type&gt;</code> is defined for the product
of each <code class="docutils literal notranslate">&lt;num&gt;</code> in the range listed above and each resource type listed in
<code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_&lt;num&gt;</code>.
Because some platforms have case-insensitive names for environment variables,
the names of resource types may not clash in a case-insensitive environment.
Because of this, for the sake of simplicity, all resource types must be
listed in all lowercase in the
<a class="reference internal" href="#ctest-resource-specification-file">resource specification file</a> and
in the <a class="reference internal" href="../prop_test/RESOURCE_GROUPS.html#prop_test:RESOURCE_GROUPS" title="RESOURCE_GROUPS"><code class="xref cmake cmake-prop_test docutils literal notranslate">RESOURCE_GROUPS</code></a> property, and they are converted to all
uppercase in the <code class="docutils literal notranslate">CTEST_RESOURCE_GROUP_&lt;num&gt;_&lt;resource-type&gt;</code> environment
variable.
</dd></dl>

</section>
</section>
<section id="see-also">
<h2><a class="toc-backref" href="#id42" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Permalink to this heading">¶</a></h2>
The following resources are available to get help using CMake:
<dl>
<dt>Home Page</dt><dd><a class="reference external" href="https://cmake.org">https://cmake.org</a>
The primary starting point for learning about CMake.
</dd>
<dt>Online Documentation and Community Resources</dt><dd><a class="reference external" href="https://cmake.org/documentation">https://cmake.org/documentation</a>
Links to available documentation and community resources may be
found on this web page.
</dd>
<dt>Discourse Forum</dt><dd><a class="reference external" href="https://discourse.cmake.org">https://discourse.cmake.org</a>
The Discourse Forum hosts discussion and questions about CMake.
</dd>
</dl>
CDash: <a class="reference external" href="https://cdash.org">https://cdash.org</a>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">ctest(1)</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#run-tests">Run Tests</a></li>
<li><a class="reference internal" href="#view-help">View Help</a></li>
<li><a class="reference internal" href="#label-matching">Label Matching</a></li>
<li><a class="reference internal" href="#label-and-subproject-summary">Label and Subproject Summary</a></li>
<li><a class="reference internal" href="#build-and-test-mode">Build and Test Mode</a></li>
<li><a class="reference internal" href="#dashboard-client">Dashboard Client</a><ul>
<li><a class="reference internal" href="#dashboard-client-steps">Dashboard Client Steps</a></li>
<li><a class="reference internal" href="#dashboard-client-modes">Dashboard Client Modes</a></li>
<li><a class="reference internal" href="#dashboard-client-via-ctest-command-line">Dashboard Client via CTest Command-Line</a></li>
<li><a class="reference internal" href="#dashboard-client-via-ctest-script">Dashboard Client via CTest Script</a></li>
</ul>
</li>
<li><a class="reference internal" href="#dashboard-client-configuration">Dashboard Client Configuration</a><ul>
<li><a class="reference internal" href="#ctest-start-step">CTest Start Step</a></li>
<li><a class="reference internal" href="#ctest-update-step">CTest Update Step</a></li>
<li><a class="reference internal" href="#ctest-configure-step">CTest Configure Step</a></li>
<li><a class="reference internal" href="#ctest-build-step">CTest Build Step</a></li>
<li><a class="reference internal" href="#ctest-test-step">CTest Test Step</a></li>
<li><a class="reference internal" href="#ctest-coverage-step">CTest Coverage Step</a></li>
<li><a class="reference internal" href="#ctest-memcheck-step">CTest MemCheck Step</a></li>
<li><a class="reference internal" href="#ctest-submit-step">CTest Submit Step</a></li>
</ul>
</li>
<li><a class="reference internal" href="#show-as-json-object-model">Show as JSON Object Model</a></li>
<li><a class="reference internal" href="#resource-allocation">Resource Allocation</a><ul>
<li><a class="reference internal" href="#resource-specification-file">Resource Specification File</a></li>
<li><a class="reference internal" href="#resource-groups-property"><code class="docutils literal notranslate">RESOURCE_GROUPS</code> Property</a></li>
<li><a class="reference internal" href="#environment-variables">Environment Variables</a></li>
</ul>
</li>
<li><a class="reference internal" href="#see-also">See Also</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="cmake.1.html"
 title="previous chapter">cmake(1)</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="cpack.1.html"
 title="next chapter">cpack(1)</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/manual/ctest.1.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="cpack.1.html" title="cpack(1)"
 >next</a> |</li>
 <li class="right" >
 <a href="cmake.1.html" title="cmake(1)"
 >previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-this"><a href="">ctest(1)</a></li> 
 </ul>
 </div>

<div class="footer" role="contentinfo">
 &#169; Copyright 2000-2023 Kitware, Inc. and Contributors.
 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
 </div>
 </body>
</html>