| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| |
| <title>ctest(1) — CMake 3.8.2 Documentation</title> |
| |
| |
| <link rel="stylesheet" href="../_static/cmake.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: '../', |
| VERSION: '3.8.2', |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: '.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script type="text/javascript" src="../_static/jquery.js"></script> |
| <script type="text/javascript" src="../_static/underscore.js"></script> |
| <script type="text/javascript" src="../_static/doctools.js"></script> |
| <link rel="shortcut icon" href="../_static/cmake-favicon.ico"/> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="cpack(1)" href="cpack.1.html" /> |
| <link rel="prev" title="cmake(1)" href="cmake.1.html" /> |
| </head> |
| <body role="document"> |
| <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> » |
| </li> |
| <li> |
| <a href="../index.html">3.8.2 Documentation</a> » |
| </li> |
| |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <span class="target" id="manual:ctest(1)"></span><div class="section" id="ctest-1"> |
| <h1>ctest(1)<a class="headerlink" href="#ctest-1" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="synopsis"> |
| <h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ctest</span> <span class="p">[</span><span class="o"><</span><span class="n">options</span><span class="o">></span><span class="p">]</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="description"> |
| <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> |
| <p>The “ctest” executable is the CMake test driver program. |
| CMake-generated build trees created for projects that use the |
| ENABLE_TESTING and ADD_TEST commands have testing support. This |
| program will run the tests and report results.</p> |
| </div> |
| <div class="section" id="options"> |
| <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">-C</span> <span class="pre"><cfg>,</span> <span class="pre">--build-config</span> <span class="pre"><cfg></span></code></dt> |
| <dd><p class="first">Choose configuration to test.</p> |
| <p class="last">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 “Debug” and |
| “Release”.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-V,--verbose</span></code></dt> |
| <dd><p class="first">Enable verbose output from tests.</p> |
| <p class="last">Test output is normally suppressed and only summary information is |
| displayed. This option will show all test output.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-VV,--extra-verbose</span></code></dt> |
| <dd><p class="first">Enable more verbose output from tests.</p> |
| <p class="last">Test output is normally suppressed and only summary information is |
| displayed. This option will show even more test output.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--debug</span></code></dt> |
| <dd><p class="first">Displaying more verbose internals of CTest.</p> |
| <p class="last">This feature will result in a large number of output that is mostly |
| useful for debugging dashboard problems.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--output-on-failure</span></code></dt> |
| <dd>Output anything outputted by the test program if the test should fail. |
| This option can also be enabled by setting the environment variable |
| <code class="docutils literal"><span class="pre">CTEST_OUTPUT_ON_FAILURE</span></code>.</dd> |
| <dt><code class="docutils literal"><span class="pre">-F</span></code></dt> |
| <dd><p class="first">Enable failover.</p> |
| <p class="last">This option allows ctest to resume a test set execution that was |
| previously interrupted. If no interruption occurred, the <code class="docutils literal"><span class="pre">-F</span></code> option |
| will have no effect.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-j</span> <span class="pre"><jobs>,</span> <span class="pre">--parallel</span> <span class="pre"><jobs></span></code></dt> |
| <dd><p class="first">Run the tests in parallel using the given number of jobs.</p> |
| <p class="last">This option tells ctest to run the tests in parallel using given |
| number of jobs. This option can also be set by setting the |
| environment variable <code class="docutils literal"><span class="pre">CTEST_PARALLEL_LEVEL</span></code>.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--test-load</span> <span class="pre"><level></span></code></dt> |
| <dd><p class="first">While running tests in parallel (e.g. with <code class="docutils literal"><span class="pre">-j</span></code>), try not to start |
| tests when they may cause the CPU load to pass above a given threshold.</p> |
| <p class="last">When <code class="docutils literal"><span class="pre">ctest</span></code> is run as a <a class="reference internal" href="#dashboard-client">Dashboard Client</a> this sets the |
| <code class="docutils literal"><span class="pre">TestLoad</span></code> option of the <a class="reference internal" href="#ctest-test-step">CTest Test Step</a>.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-Q,--quiet</span></code></dt> |
| <dd><p class="first">Make ctest quiet.</p> |
| <p class="last">This option will suppress all the output. The output log file will |
| still be generated if the <code class="docutils literal"><span class="pre">--output-log</span></code> is specified. Options such |
| as <code class="docutils literal"><span class="pre">--verbose</span></code>, <code class="docutils literal"><span class="pre">--extra-verbose</span></code>, and <code class="docutils literal"><span class="pre">--debug</span></code> are ignored |
| if <code class="docutils literal"><span class="pre">--quiet</span></code> is specified.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-O</span> <span class="pre"><file>,</span> <span class="pre">--output-log</span> <span class="pre"><file></span></code></dt> |
| <dd><p class="first">Output to log file.</p> |
| <p class="last">This option tells ctest to write all its output to a log file.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-N,--show-only</span></code></dt> |
| <dd><p class="first">Disable actual execution of tests.</p> |
| <p class="last">This option tells ctest to list the tests that would be run but not |
| actually run them. Useful in conjunction with the <code class="docutils literal"><span class="pre">-R</span></code> and <code class="docutils literal"><span class="pre">-E</span></code> |
| options.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-L</span> <span class="pre"><regex>,</span> <span class="pre">--label-regex</span> <span class="pre"><regex></span></code></dt> |
| <dd><p class="first">Run tests with labels matching regular expression.</p> |
| <p class="last">This option tells ctest to run only the tests whose labels match the |
| given regular expression.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-R</span> <span class="pre"><regex>,</span> <span class="pre">--tests-regex</span> <span class="pre"><regex></span></code></dt> |
| <dd><p class="first">Run tests matching regular expression.</p> |
| <p class="last">This option tells ctest to run only the tests whose names match the |
| given regular expression.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-E</span> <span class="pre"><regex>,</span> <span class="pre">--exclude-regex</span> <span class="pre"><regex></span></code></dt> |
| <dd><p class="first">Exclude tests matching regular expression.</p> |
| <p class="last">This option tells ctest to NOT run the tests whose names match the |
| given regular expression.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-LE</span> <span class="pre"><regex>,</span> <span class="pre">--label-exclude</span> <span class="pre"><regex></span></code></dt> |
| <dd><p class="first">Exclude tests with labels matching regular expression.</p> |
| <p class="last">This option tells ctest to NOT run the tests whose labels match the |
| given regular expression.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-D</span> <span class="pre"><dashboard>,</span> <span class="pre">--dashboard</span> <span class="pre"><dashboard></span></code></dt> |
| <dd><p class="first">Execute dashboard test.</p> |
| <p class="last">This option tells ctest to act as a CDash client and perform a |
| dashboard test. All tests are <Mode><Test>, where Mode can be |
| Experimental, Nightly, and Continuous, and Test can be Start, |
| Update, Configure, Build, Test, Coverage, and Submit.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-D</span> <span class="pre"><var>:<type>=<value></span></code></dt> |
| <dd><p class="first">Define a variable for script mode.</p> |
| <p class="last">Pass in variable values on the command line. Use in conjunction |
| with <code class="docutils literal"><span class="pre">-S</span></code> to pass variable values to a dashboard script. Parsing <code class="docutils literal"><span class="pre">-D</span></code> |
| arguments as variable values is only attempted if the value |
| following <code class="docutils literal"><span class="pre">-D</span></code> does not match any of the known dashboard types.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-M</span> <span class="pre"><model>,</span> <span class="pre">--test-model</span> <span class="pre"><model></span></code></dt> |
| <dd><p class="first">Sets the model for a dashboard.</p> |
| <p class="last">This option tells ctest to act as a CDash client where the <code class="docutils literal"><span class="pre"><model></span></code> |
| can be <code class="docutils literal"><span class="pre">Experimental</span></code>, <code class="docutils literal"><span class="pre">Nightly</span></code>, and <code class="docutils literal"><span class="pre">Continuous</span></code>. |
| Combining <code class="docutils literal"><span class="pre">-M</span></code> and <code class="docutils literal"><span class="pre">-T</span></code> is similar to <code class="docutils literal"><span class="pre">-D</span></code>.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-T</span> <span class="pre"><action>,</span> <span class="pre">--test-action</span> <span class="pre"><action></span></code></dt> |
| <dd><p class="first">Sets the dashboard action to perform.</p> |
| <p class="last">This option tells ctest to act as a CDash client and perform some |
| action such as <code class="docutils literal"><span class="pre">start</span></code>, <code class="docutils literal"><span class="pre">build</span></code>, <code class="docutils literal"><span class="pre">test</span></code> etc. See |
| <a class="reference internal" href="#dashboard-client-steps">Dashboard Client Steps</a> for the full list of actions. |
| Combining <code class="docutils literal"><span class="pre">-M</span></code> and <code class="docutils literal"><span class="pre">-T</span></code> is similar to <code class="docutils literal"><span class="pre">-D</span></code>.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--track</span> <span class="pre"><track></span></code></dt> |
| <dd><p class="first">Specify the track to submit dashboard to</p> |
| <p class="last">Submit dashboard to specified track instead of default one. By |
| default, the dashboard is submitted to Nightly, Experimental, or |
| Continuous track, but by specifying this option, the track can be |
| arbitrary.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-S</span> <span class="pre"><script>,</span> <span class="pre">--script</span> <span class="pre"><script></span></code></dt> |
| <dd><p class="first">Execute a dashboard for a configuration.</p> |
| <p class="last">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 <code class="docutils literal"><span class="pre">ctest</span> <span class="pre">-D</span></code> |
| with the appropriate options.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-SP</span> <span class="pre"><script>,</span> <span class="pre">--script-new-process</span> <span class="pre"><script></span></code></dt> |
| <dd><p class="first">Execute a dashboard for a configuration.</p> |
| <p class="last">This option does the same operations as <code class="docutils literal"><span class="pre">-S</span></code> 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 <code class="docutils literal"><span class="pre">-S</span></code> scripts.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-A</span> <span class="pre"><file>,</span> <span class="pre">--add-notes</span> <span class="pre"><file></span></code></dt> |
| <dd><p class="first">Add a notes file with submission.</p> |
| <p class="last">This option tells ctest to include a notes file when submitting |
| dashboard.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-I</span> <span class="pre">[Start,End,Stride,test#,test#|Test</span> <span class="pre">file],</span> <span class="pre">--tests-information</span></code></dt> |
| <dd><p class="first">Run a specific number of tests by number.</p> |
| <p class="last">This option causes ctest to run tests starting at number Start, |
| ending at number End, and incrementing by Stride. Any additional |
| numbers after Stride are considered individual test numbers. Start, |
| End,or stride can be empty. Optionally a file can be given that |
| contains the same syntax as the command line.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">-U,</span> <span class="pre">--union</span></code></dt> |
| <dd><p class="first">Take the Union of <code class="docutils literal"><span class="pre">-I</span></code> and <code class="docutils literal"><span class="pre">-R</span></code>.</p> |
| <p class="last">When both <code class="docutils literal"><span class="pre">-R</span></code> and <code class="docutils literal"><span class="pre">-I</span></code> are specified by default the intersection of |
| tests are run. By specifying <code class="docutils literal"><span class="pre">-U</span></code> the union of tests is run instead.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--rerun-failed</span></code></dt> |
| <dd><p class="first">Run only the tests that failed previously.</p> |
| <p class="last">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 (<code class="docutils literal"><span class="pre">-L</span></code>, <code class="docutils literal"><span class="pre">-R</span></code>, |
| <code class="docutils literal"><span class="pre">-E</span></code>, <code class="docutils literal"><span class="pre">-LE</span></code>, <code class="docutils literal"><span class="pre">-I</span></code>, etc). In the event that CTest runs and no tests |
| fail, subsequent calls to ctest with the <code class="docutils literal"><span class="pre">--rerun-failed</span></code> option will run |
| the set of tests that most recently failed (if any).</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--repeat-until-fail</span> <span class="pre"><n></span></code></dt> |
| <dd><p class="first">Require each test to run <code class="docutils literal"><span class="pre"><n></span></code> times without failing in order to pass.</p> |
| <p class="last">This is useful in finding sporadic failures in test cases.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--max-width</span> <span class="pre"><width></span></code></dt> |
| <dd><p class="first">Set the max width for a test name to output.</p> |
| <p class="last">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.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--interactive-debug-mode</span> <span class="pre">[0|1]</span></code></dt> |
| <dd><p class="first">Set the interactive mode to 0 or 1.</p> |
| <p class="last">This option causes ctest to run tests in either an interactive mode |
| or a non-interactive mode. On Windows this means that in |
| non-interactive mode, all system debug pop up windows are blocked. |
| In dashboard mode (Experimental, Nightly, Continuous), the default |
| is non-interactive. When just running tests not for a dashboard the |
| default is to allow popups and interactive debugging.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--no-label-summary</span></code></dt> |
| <dd><p class="first">Disable timing summary information for labels.</p> |
| <p class="last">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.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--build-and-test</span> <span class="pre"><path-to-source></span> <span class="pre"><path-to-build></span></code></dt> |
| <dd><p class="first">Configure, build and run a test.</p> |
| <p class="last">This option tells ctest to configure (i.e. run cmake on), build, |
| and or execute a test. The configure and test steps are optional. |
| The arguments to this command line are the source and binary |
| directories. |
| The <code class="docutils literal"><span class="pre">--build-generator</span></code> option <em>must</em> be provided to use |
| <code class="docutils literal"><span class="pre">--build-and-test</span></code>. If <code class="docutils literal"><span class="pre">--test-command</span></code> is specified then that will be |
| run after the build is complete. Other options that affect this |
| mode are <code class="docutils literal"><span class="pre">--build-target</span></code>, <code class="docutils literal"><span class="pre">--build-nocmake</span></code>, <code class="docutils literal"><span class="pre">--build-run-dir</span></code>, |
| <code class="docutils literal"><span class="pre">--build-two-config</span></code>, <code class="docutils literal"><span class="pre">--build-exe-dir</span></code>, |
| <code class="docutils literal"><span class="pre">--build-project</span></code>, <code class="docutils literal"><span class="pre">--build-noclean</span></code> and <code class="docutils literal"><span class="pre">--build-options</span></code>.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--build-target</span></code></dt> |
| <dd><p class="first">Specify a specific target to build.</p> |
| <p class="last">This option goes with the <code class="docutils literal"><span class="pre">--build-and-test</span></code> option, if left out the |
| <code class="docutils literal"><span class="pre">all</span></code> target is built.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--build-nocmake</span></code></dt> |
| <dd><p class="first">Run the build without running cmake first.</p> |
| <p class="last">Skip the cmake step.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--build-run-dir</span></code></dt> |
| <dd><p class="first">Specify directory to run programs from.</p> |
| <p class="last">Directory where programs will be after it has been compiled.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--build-two-config</span></code></dt> |
| <dd>Run CMake twice.</dd> |
| <dt><code class="docutils literal"><span class="pre">--build-exe-dir</span></code></dt> |
| <dd>Specify the directory for the executable.</dd> |
| <dt><code class="docutils literal"><span class="pre">--build-generator</span></code></dt> |
| <dd>Specify the generator to use. See the <span class="target" id="index-0-manual:cmake-generators(7)"></span><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"><span class="pre">cmake-generators(7)</span></code></a> manual.</dd> |
| <dt><code class="docutils literal"><span class="pre">--build-generator-platform</span></code></dt> |
| <dd>Specify the generator-specific platform.</dd> |
| <dt><code class="docutils literal"><span class="pre">--build-generator-toolset</span></code></dt> |
| <dd>Specify the generator-specific toolset.</dd> |
| <dt><code class="docutils literal"><span class="pre">--build-project</span></code></dt> |
| <dd>Specify the name of the project to build.</dd> |
| <dt><code class="docutils literal"><span class="pre">--build-makeprogram</span></code></dt> |
| <dd>Override the make program chosen by CTest with a given one.</dd> |
| <dt><code class="docutils literal"><span class="pre">--build-noclean</span></code></dt> |
| <dd>Skip the make clean step.</dd> |
| <dt><code class="docutils literal"><span class="pre">--build-config-sample</span></code></dt> |
| <dd>A sample executable to use to determine the configuration that |
| should be used. e.g. Debug/Release/etc.</dd> |
| <dt><code class="docutils literal"><span class="pre">--build-options</span></code></dt> |
| <dd><p class="first">Add extra options to the build step.</p> |
| <p class="last">This option must be the last option with the exception of |
| <code class="docutils literal"><span class="pre">--test-command</span></code></p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--test-command</span></code></dt> |
| <dd>The test to run with the <code class="docutils literal"><span class="pre">--build-and-test</span></code> option.</dd> |
| <dt><code class="docutils literal"><span class="pre">--test-output-size-passed</span> <span class="pre"><size></span></code></dt> |
| <dd>Limit the output for passed tests to <code class="docutils literal"><span class="pre"><size></span></code> bytes.</dd> |
| <dt><code class="docutils literal"><span class="pre">--test-output-size-failed</span> <span class="pre"><size></span></code></dt> |
| <dd>Limit the output for failed tests to <code class="docutils literal"><span class="pre"><size></span></code> bytes.</dd> |
| <dt><code class="docutils literal"><span class="pre">--test-timeout</span></code></dt> |
| <dd>The time limit in seconds, internal use only.</dd> |
| <dt><code class="docutils literal"><span class="pre">--tomorrow-tag</span></code></dt> |
| <dd><p class="first">Nightly or experimental starts with next day tag.</p> |
| <p class="last">This is useful if the build will not finish in one day.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--ctest-config</span></code></dt> |
| <dd><p class="first">The configuration file used to initialize CTest state when submitting dashboards.</p> |
| <p class="last">This option tells CTest to use different initialization file instead |
| of CTestConfiguration.tcl. This way multiple initialization files |
| can be used for example to submit to multiple dashboards.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--overwrite</span></code></dt> |
| <dd><p class="first">Overwrite CTest configuration option.</p> |
| <p class="last">By default ctest uses configuration options from configuration file. |
| This option will overwrite the configuration option.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--extra-submit</span> <span class="pre"><file>[;<file>]</span></code></dt> |
| <dd><p class="first">Submit extra files to the dashboard.</p> |
| <p class="last">This option will submit extra files to the dashboard.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--force-new-ctest-process</span></code></dt> |
| <dd><p class="first">Run child CTest instances as new processes.</p> |
| <p class="last">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.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--schedule-random</span></code></dt> |
| <dd><p class="first">Use a random order for scheduling tests.</p> |
| <p class="last">This option will run the tests in a random order. It is commonly |
| used to detect implicit dependencies in a test suite.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--submit-index</span></code></dt> |
| <dd>Legacy option for old Dart2 dashboard server feature. |
| Do not use.</dd> |
| <dt><code class="docutils literal"><span class="pre">--timeout</span> <span class="pre"><seconds></span></code></dt> |
| <dd><p class="first">Set a global timeout on all tests.</p> |
| <p class="last">This option will set a global timeout on all tests that do not |
| already have a timeout set on them.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--stop-time</span> <span class="pre"><time></span></code></dt> |
| <dd><p class="first">Set a time at which all tests should stop running.</p> |
| <p class="last">Set a real time of day at which all tests should timeout. Example: |
| <code class="docutils literal"><span class="pre">7:00:00</span> <span class="pre">-0400</span></code>. Any time format understood by the curl date parser |
| is accepted. Local time is assumed if no timezone is specified.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--http1.0</span></code></dt> |
| <dd><p class="first">Submit using HTTP 1.0.</p> |
| <p class="last">This option will force CTest to use HTTP 1.0 to submit files to the |
| dashboard, instead of HTTP 1.1.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--no-compress-output</span></code></dt> |
| <dd><p class="first">Do not compress test output when submitting.</p> |
| <p class="last">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.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--print-labels</span></code></dt> |
| <dd><p class="first">Print all available test labels.</p> |
| <p class="last">This option will not run any tests, it will simply print the list of |
| all labels associated with the test set.</p> |
| </dd> |
| </dl> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">--help,-help,-usage,-h,-H,/?</span></code></dt> |
| <dd><p class="first">Print usage information and exit.</p> |
| <p class="last">Usage describes the basic command line interface and its options.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--version,-version,/V</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Show program name/version banner and exit.</p> |
| <p class="last">If a file is specified, the version is written into it. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-full</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print all help manuals and exit.</p> |
| <p class="last">All manuals are printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-manual</span> <span class="pre"><man></span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print one help manual and exit.</p> |
| <p class="last">The specified manual is printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-manual-list</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">List help manuals available and exit.</p> |
| <p class="last">The list contains all manuals for which help may be obtained by |
| using the <code class="docutils literal"><span class="pre">--help-manual</span></code> option followed by a manual name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-command</span> <span class="pre"><cmd></span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print help for one command and exit.</p> |
| <p class="last">The <span class="target" id="index-0-manual:cmake-commands(7)"></span><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"><span class="pre">cmake-commands(7)</span></code></a> manual entry for <code class="docutils literal"><span class="pre"><cmd></span></code> is |
| printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-command-list</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">List commands with help available and exit.</p> |
| <p class="last">The list contains all commands for which help may be obtained by |
| using the <code class="docutils literal"><span class="pre">--help-command</span></code> option followed by a command name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-commands</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print cmake-commands manual and exit.</p> |
| <p class="last">The <span class="target" id="index-1-manual:cmake-commands(7)"></span><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"><span class="pre">cmake-commands(7)</span></code></a> manual is printed in a |
| human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-module</span> <span class="pre"><mod></span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print help for one module and exit.</p> |
| <p class="last">The <span class="target" id="index-0-manual:cmake-modules(7)"></span><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"><span class="pre">cmake-modules(7)</span></code></a> manual entry for <code class="docutils literal"><span class="pre"><mod></span></code> is printed |
| in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-module-list</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">List modules with help available and exit.</p> |
| <p class="last">The list contains all modules for which help may be obtained by |
| using the <code class="docutils literal"><span class="pre">--help-module</span></code> option followed by a module name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-modules</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print cmake-modules manual and exit.</p> |
| <p class="last">The <span class="target" id="index-1-manual:cmake-modules(7)"></span><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"><span class="pre">cmake-modules(7)</span></code></a> manual is printed in a human-readable |
| text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-policy</span> <span class="pre"><cmp></span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print help for one policy and exit.</p> |
| <p class="last">The <span class="target" id="index-0-manual:cmake-policies(7)"></span><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"><span class="pre">cmake-policies(7)</span></code></a> manual entry for <code class="docutils literal"><span class="pre"><cmp></span></code> is |
| printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-policy-list</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">List policies with help available and exit.</p> |
| <p class="last">The list contains all policies for which help may be obtained by |
| using the <code class="docutils literal"><span class="pre">--help-policy</span></code> option followed by a policy name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-policies</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print cmake-policies manual and exit.</p> |
| <p class="last">The <span class="target" id="index-1-manual:cmake-policies(7)"></span><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"><span class="pre">cmake-policies(7)</span></code></a> manual is printed in a |
| human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-property</span> <span class="pre"><prop></span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print help for one property and exit.</p> |
| <p class="last">The <span class="target" id="index-0-manual:cmake-properties(7)"></span><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"><span class="pre">cmake-properties(7)</span></code></a> manual entries for <code class="docutils literal"><span class="pre"><prop></span></code> are |
| printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-property-list</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">List properties with help available and exit.</p> |
| <p class="last">The list contains all properties for which help may be obtained by |
| using the <code class="docutils literal"><span class="pre">--help-property</span></code> option followed by a property name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-properties</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print cmake-properties manual and exit.</p> |
| <p class="last">The <span class="target" id="index-1-manual:cmake-properties(7)"></span><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"><span class="pre">cmake-properties(7)</span></code></a> manual is printed in a |
| human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-variable</span> <span class="pre"><var></span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print help for one variable and exit.</p> |
| <p class="last">The <span class="target" id="index-0-manual:cmake-variables(7)"></span><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"><span class="pre">cmake-variables(7)</span></code></a> manual entry for <code class="docutils literal"><span class="pre"><var></span></code> is |
| printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-variable-list</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">List variables with help available and exit.</p> |
| <p class="last">The list contains all variables for which help may be obtained by |
| using the <code class="docutils literal"><span class="pre">--help-variable</span></code> option followed by a variable name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">--help-variables</span> <span class="pre">[<f>]</span></code></dt> |
| <dd><p class="first">Print cmake-variables manual and exit.</p> |
| <p class="last">The <span class="target" id="index-1-manual:cmake-variables(7)"></span><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"><span class="pre">cmake-variables(7)</span></code></a> manual is printed in a |
| human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="dashboard-client"> |
| <span id="id1"></span><h2>Dashboard Client<a class="headerlink" href="#dashboard-client" title="Permalink to this headline">¶</a></h2> |
| <p>CTest can operate as a client for the <a class="reference external" href="http://cdash.org/">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 external" href="http://cdash.org/">CDash</a> server.</p> |
| <div class="section" id="dashboard-client-steps"> |
| <h3>Dashboard Client Steps<a class="headerlink" href="#dashboard-client-steps" title="Permalink to this headline">¶</a></h3> |
| <p>CTest defines an ordered list of testing steps of which some or all may |
| be run as a dashboard client:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">Start</span></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"><span class="pre">Update</span></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"><span class="pre">Configure</span></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"><span class="pre">Build</span></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"><span class="pre">Test</span></code></dt> |
| <dd>Test the software by loading a <code class="docutils literal"><span class="pre">CTestTestfile.cmake</span></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"><span class="pre">Coverage</span></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"><span class="pre">MemCheck</span></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"><span class="pre">Submit</span></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> |
| </div> |
| <div class="section" id="dashboard-client-modes"> |
| <h3>Dashboard Client Modes<a class="headerlink" href="#dashboard-client-modes" title="Permalink to this headline">¶</a></h3> |
| <p>CTest defines three modes of operation as a dashboard client:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">Nightly</span></code></dt> |
| <dd>This mode is intended to be invoked once per day, typically at night. |
| It enables the <code class="docutils literal"><span class="pre">Start</span></code>, <code class="docutils literal"><span class="pre">Update</span></code>, <code class="docutils literal"><span class="pre">Configure</span></code>, <code class="docutils literal"><span class="pre">Build</span></code>, <code class="docutils literal"><span class="pre">Test</span></code>, |
| <code class="docutils literal"><span class="pre">Coverage</span></code>, and <code class="docutils literal"><span class="pre">Submit</span></code> steps by default. Selected steps run even |
| if the <code class="docutils literal"><span class="pre">Update</span></code> step reports no changes to the source tree.</dd> |
| <dt><code class="docutils literal"><span class="pre">Continuous</span></code></dt> |
| <dd>This mode is intended to be invoked repeatedly throughout the day. |
| It enables the <code class="docutils literal"><span class="pre">Start</span></code>, <code class="docutils literal"><span class="pre">Update</span></code>, <code class="docutils literal"><span class="pre">Configure</span></code>, <code class="docutils literal"><span class="pre">Build</span></code>, <code class="docutils literal"><span class="pre">Test</span></code>, |
| <code class="docutils literal"><span class="pre">Coverage</span></code>, and <code class="docutils literal"><span class="pre">Submit</span></code> steps by default, but exits after the |
| <code class="docutils literal"><span class="pre">Update</span></code> step if it reports no changes to the source tree.</dd> |
| <dt><code class="docutils literal"><span class="pre">Experimental</span></code></dt> |
| <dd>This mode is intended to be invoked by a developer to test local changes. |
| It enables the <code class="docutils literal"><span class="pre">Start</span></code>, <code class="docutils literal"><span class="pre">Configure</span></code>, <code class="docutils literal"><span class="pre">Build</span></code>, <code class="docutils literal"><span class="pre">Test</span></code>, <code class="docutils literal"><span class="pre">Coverage</span></code>, |
| and <code class="docutils literal"><span class="pre">Submit</span></code> steps by default.</dd> |
| </dl> |
| </div> |
| <div class="section" id="dashboard-client-via-ctest-command-line"> |
| <h3>Dashboard Client via CTest Command-Line<a class="headerlink" href="#dashboard-client-via-ctest-command-line" title="Permalink to this headline">¶</a></h3> |
| <p>CTest can perform testing on an already-generated build tree. |
| Run the <code class="docutils literal"><span class="pre">ctest</span></code> command with the current working directory set |
| to the build tree and use one of these signatures:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ctest</span> <span class="o">-</span><span class="n">D</span> <span class="o"><</span><span class="n">mode</span><span class="o">></span><span class="p">[</span><span class="o"><</span><span class="n">step</span><span class="o">></span><span class="p">]</span> |
| <span class="n">ctest</span> <span class="o">-</span><span class="n">M</span> <span class="o"><</span><span class="n">mode</span><span class="o">></span> <span class="p">[</span> <span class="o">-</span><span class="n">T</span> <span class="o"><</span><span class="n">step</span><span class="o">></span> <span class="p">]</span><span class="o">...</span> |
| </pre></div> |
| </div> |
| <p>The <code class="docutils literal"><span class="pre"><mode></span></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"><span class="pre"><step></span></code> must be one of the above <a class="reference internal" href="#dashboard-client-steps">Dashboard Client Steps</a>.</p> |
| <p>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"><span class="pre">CTestConfiguration.ini</span></code> |
| or <code class="docutils literal"><span class="pre">DartConfiguration.tcl</span></code> (the names are historical). The format |
| of the file is:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Lines starting in '#' are comments.</span> |
| <span class="c1"># Other non-blank lines are key-value pairs.</span> |
| <span class="o"><</span><span class="n">setting</span><span class="o">></span><span class="p">:</span> <span class="o"><</span><span class="n">value</span><span class="o">></span> |
| </pre></div> |
| </div> |
| <p>where <code class="docutils literal"><span class="pre"><setting></span></code> is the setting name and <code class="docutils literal"><span class="pre"><value></span></code> is the |
| setting value.</p> |
| <p>In build trees generated by CMake, this configuration file is |
| generated by the <span class="target" id="index-0-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></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.</p> |
| </div> |
| <div class="section" id="dashboard-client-via-ctest-script"> |
| <span id="ctest-script"></span><h3>Dashboard Client via CTest Script<a class="headerlink" href="#dashboard-client-via-ctest-script" title="Permalink to this headline">¶</a></h3> |
| <p>CTest can perform testing driven by a <span class="target" id="index-0-manual:cmake-language(7)"></span><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"><span class="pre">cmake-language(7)</span></code></a> |
| script that creates and maintains the source and build tree as |
| well as performing the testing steps. Run the <code class="docutils literal"><span class="pre">ctest</span></code> command |
| with the current working directory set outside of any build tree |
| and use one of these signatures:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ctest</span> <span class="o">-</span><span class="n">S</span> <span class="o"><</span><span class="n">script</span><span class="o">></span> |
| <span class="n">ctest</span> <span class="o">-</span><span class="n">SP</span> <span class="o"><</span><span class="n">script</span><span class="o">></span> |
| </pre></div> |
| </div> |
| <p>The <code class="docutils literal"><span class="pre"><script></span></code> file must call <a class="reference internal" href="cmake-commands.7.html#ctest-commands"><span class="std std-ref">CTest Commands</span></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.</p> |
| </div> |
| </div> |
| <div class="section" id="dashboard-client-configuration"> |
| <h2>Dashboard Client Configuration<a class="headerlink" href="#dashboard-client-configuration" title="Permalink to this headline">¶</a></h2> |
| <p>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.</p> |
| <div class="section" id="ctest-start-step"> |
| <span id="id2"></span><h3>CTest Start Step<a class="headerlink" href="#ctest-start-step" title="Permalink to this headline">¶</a></h3> |
| <p>Start a new dashboard submission to be composed of results recorded |
| by the following steps.</p> |
| <p>In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <span class="target" id="index-0-command:ctest_start"></span><a class="reference internal" href="../command/ctest_start.html#command:ctest_start" title="ctest_start"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_start()</span></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"><span class="pre">CTEST_CHECKOUT_COMMAND</span></code> variable, if set, to initialize the source |
| directory.</p> |
| <p>Configuration settings include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">BuildDirectory</span></code></dt> |
| <dd><p class="first">The full path to the project build tree.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_BINARY_DIRECTORY"></span><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"><span class="pre">CTEST_BINARY_DIRECTORY</span></code></a></li> |
| <li><span class="target" id="index-1-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <span class="target" id="index-0-variable:PROJECT_BINARY_DIR"></span><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"><span class="pre">PROJECT_BINARY_DIR</span></code></a></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">SourceDirectory</span></code></dt> |
| <dd><p class="first">The full path to the project source tree.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_SOURCE_DIRECTORY"></span><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"><span class="pre">CTEST_SOURCE_DIRECTORY</span></code></a></li> |
| <li><span class="target" id="index-2-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <span class="target" id="index-0-variable:PROJECT_SOURCE_DIR"></span><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"><span class="pre">PROJECT_SOURCE_DIR</span></code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="ctest-update-step"> |
| <span id="id3"></span><h3>CTest Update Step<a class="headerlink" href="#ctest-update-step" title="Permalink to this headline">¶</a></h3> |
| <p>In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <span class="target" id="index-0-command:ctest_update"></span><a class="reference internal" href="../command/ctest_update.html#command:ctest_update" title="ctest_update"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_update()</span></code></a> command runs this step. |
| Arguments to the command may specify some of the step settings.</p> |
| <p>Configuration settings to specify the version control tool include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">BZRCommand</span></code></dt> |
| <dd><p class="first"><code class="docutils literal"><span class="pre">bzr</span></code> command-line tool to use if source tree is managed by Bazaar.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_BZR_COMMAND"></span><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"><span class="pre">CTEST_BZR_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-3-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: none</li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">BZRUpdateOptions</span></code></dt> |
| <dd><p class="first">Command-line options to the <code class="docutils literal"><span class="pre">BZRCommand</span></code> when updating the source.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_BZR_UPDATE_OPTIONS"></span><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"><span class="pre">CTEST_BZR_UPDATE_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-4-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: none</li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">CVSCommand</span></code></dt> |
| <dd><p class="first"><code class="docutils literal"><span class="pre">cvs</span></code> command-line tool to use if source tree is managed by CVS.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_CVS_COMMAND"></span><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"><span class="pre">CTEST_CVS_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-5-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CVSCOMMAND</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">CVSUpdateOptions</span></code></dt> |
| <dd><p class="first">Command-line options to the <code class="docutils literal"><span class="pre">CVSCommand</span></code> when updating the source.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_CVS_UPDATE_OPTIONS"></span><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"><span class="pre">CTEST_CVS_UPDATE_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-6-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CVS_UPDATE_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">GITCommand</span></code></dt> |
| <dd><p class="first"><code class="docutils literal"><span class="pre">git</span></code> command-line tool to use if source tree is managed by Git.</p> |
| <ul class="simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_GIT_COMMAND"></span><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"><span class="pre">CTEST_GIT_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-7-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">GITCOMMAND</span></code></li> |
| </ul> |
| <p class="last">The source tree is updated by <code class="docutils literal"><span class="pre">git</span> <span class="pre">fetch</span></code> followed by |
| <code class="docutils literal"><span class="pre">git</span> <span class="pre">reset</span> <span class="pre">--hard</span></code> to the <code class="docutils literal"><span class="pre">FETCH_HEAD</span></code>. The result is the same |
| as <code class="docutils literal"><span class="pre">git</span> <span class="pre">pull</span></code> except that any local moficiations are overwritten. |
| Use <code class="docutils literal"><span class="pre">GITUpdateCustom</span></code> to specify a different approach.</p> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">GITInitSubmodules</span></code></dt> |
| <dd><p class="first">If set, CTest will update the repository’s submodules before updating.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_GIT_INIT_SUBMODULES"></span><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"><span class="pre">CTEST_GIT_INIT_SUBMODULES</span></code></a></li> |
| <li><span class="target" id="index-8-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_GIT_INIT_SUBMODULES</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">GITUpdateCustom</span></code></dt> |
| <dd><p class="first">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"><span class="pre">GITCommand</span></code>.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_GIT_UPDATE_CUSTOM"></span><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"><span class="pre">CTEST_GIT_UPDATE_CUSTOM</span></code></a></li> |
| <li><span class="target" id="index-9-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_GIT_UPDATE_CUSTOM</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">GITUpdateOptions</span></code></dt> |
| <dd><p class="first">Command-line options to the <code class="docutils literal"><span class="pre">GITCommand</span></code> when updating the source.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_GIT_UPDATE_OPTIONS"></span><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"><span class="pre">CTEST_GIT_UPDATE_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-10-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">GIT_UPDATE_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">HGCommand</span></code></dt> |
| <dd><p class="first"><code class="docutils literal"><span class="pre">hg</span></code> command-line tool to use if source tree is managed by Mercurial.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_HG_COMMAND"></span><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"><span class="pre">CTEST_HG_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-11-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: none</li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">HGUpdateOptions</span></code></dt> |
| <dd><p class="first">Command-line options to the <code class="docutils literal"><span class="pre">HGCommand</span></code> when updating the source.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_HG_UPDATE_OPTIONS"></span><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"><span class="pre">CTEST_HG_UPDATE_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-12-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: none</li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">P4Client</span></code></dt> |
| <dd><p class="first">Value of the <code class="docutils literal"><span class="pre">-c</span></code> option to the <code class="docutils literal"><span class="pre">P4Command</span></code>.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_P4_CLIENT"></span><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"><span class="pre">CTEST_P4_CLIENT</span></code></a></li> |
| <li><span class="target" id="index-13-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_P4_CLIENT</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">P4Command</span></code></dt> |
| <dd><p class="first"><code class="docutils literal"><span class="pre">p4</span></code> command-line tool to use if source tree is managed by Perforce.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_P4_COMMAND"></span><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"><span class="pre">CTEST_P4_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-14-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">P4COMMAND</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">P4Options</span></code></dt> |
| <dd><p class="first">Command-line options to the <code class="docutils literal"><span class="pre">P4Command</span></code> for all invocations.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_P4_OPTIONS"></span><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"><span class="pre">CTEST_P4_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-15-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_P4_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">P4UpdateCustom</span></code></dt> |
| <dd><p class="first">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"><span class="pre">P4Command</span></code>.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li> |
| <li><span class="target" id="index-16-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_P4_UPDATE_CUSTOM</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">P4UpdateOptions</span></code></dt> |
| <dd><p class="first">Command-line options to the <code class="docutils literal"><span class="pre">P4Command</span></code> when updating the source.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_P4_UPDATE_OPTIONS"></span><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"><span class="pre">CTEST_P4_UPDATE_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-17-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_P4_UPDATE_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">SVNCommand</span></code></dt> |
| <dd><p class="first"><code class="docutils literal"><span class="pre">svn</span></code> command-line tool to use if source tree is managed by Subversion.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_SVN_COMMAND"></span><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"><span class="pre">CTEST_SVN_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-18-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">SVNCOMMAND</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">SVNOptions</span></code></dt> |
| <dd><p class="first">Command-line options to the <code class="docutils literal"><span class="pre">SVNCommand</span></code> for all invocations.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_SVN_OPTIONS"></span><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"><span class="pre">CTEST_SVN_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-19-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_SVN_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">SVNUpdateOptions</span></code></dt> |
| <dd><p class="first">Command-line options to the <code class="docutils literal"><span class="pre">SVNCommand</span></code> when updating the source.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_SVN_UPDATE_OPTIONS"></span><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"><span class="pre">CTEST_SVN_UPDATE_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-20-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">SVN_UPDATE_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">UpdateCommand</span></code></dt> |
| <dd><p class="first">Specify the version-control command-line tool to use without |
| detecting the VCS that manages the source tree.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_UPDATE_COMMAND"></span><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"><span class="pre">CTEST_UPDATE_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-21-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre"><VCS>COMMAND</span></code> |
| when <code class="docutils literal"><span class="pre">UPDATE_TYPE</span></code> is <code class="docutils literal"><span class="pre"><vcs></span></code>, else <code class="docutils literal"><span class="pre">UPDATE_COMMAND</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">UpdateOptions</span></code></dt> |
| <dd><p class="first">Command-line options to the <code class="docutils literal"><span class="pre">UpdateCommand</span></code>.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_UPDATE_OPTIONS"></span><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"><span class="pre">CTEST_UPDATE_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-22-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre"><VCS>_UPDATE_OPTIONS</span></code> |
| when <code class="docutils literal"><span class="pre">UPDATE_TYPE</span></code> is <code class="docutils literal"><span class="pre"><vcs></span></code>, else <code class="docutils literal"><span class="pre">UPDATE_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">UpdateType</span></code></dt> |
| <dd><p class="first">Specify the version-control system that manages the source |
| tree if it cannot be detected automatically. |
| The value may be <code class="docutils literal"><span class="pre">bzr</span></code>, <code class="docutils literal"><span class="pre">cvs</span></code>, <code class="docutils literal"><span class="pre">git</span></code>, <code class="docutils literal"><span class="pre">hg</span></code>, |
| <code class="docutils literal"><span class="pre">p4</span></code>, or <code class="docutils literal"><span class="pre">svn</span></code>.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none, detected from source tree</li> |
| <li><span class="target" id="index-23-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">UPDATE_TYPE</span></code> if set, |
| else <code class="docutils literal"><span class="pre">CTEST_UPDATE_TYPE</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">UpdateVersionOnly</span></code></dt> |
| <dd><p class="first">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.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_UPDATE_VERSION_ONLY"></span><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"><span class="pre">CTEST_UPDATE_VERSION_ONLY</span></code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| <p>Additional configuration settings include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">NightlyStartTime</span></code></dt> |
| <dd><p class="first">In the <code class="docutils literal"><span class="pre">Nightly</span></code> dashboard mode, specify the “nightly start time”. |
| With centralized version control systems (<code class="docutils literal"><span class="pre">cvs</span></code> and <code class="docutils literal"><span class="pre">svn</span></code>), |
| the <code class="docutils literal"><span class="pre">Update</span></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.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_NIGHTLY_START_TIME"></span><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"><span class="pre">CTEST_NIGHTLY_START_TIME</span></code></a></li> |
| <li><span class="target" id="index-24-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">NIGHTLY_START_TIME</span></code> if set, |
| else <code class="docutils literal"><span class="pre">CTEST_NIGHTLY_START_TIME</span></code></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="ctest-configure-step"> |
| <span id="id4"></span><h3>CTest Configure Step<a class="headerlink" href="#ctest-configure-step" title="Permalink to this headline">¶</a></h3> |
| <p>In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <span class="target" id="index-0-command:ctest_configure"></span><a class="reference internal" href="../command/ctest_configure.html#command:ctest_configure" title="ctest_configure"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_configure()</span></code></a> command runs this step. |
| Arguments to the command may specify some of the step settings.</p> |
| <p>Configuration settings include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">ConfigureCommand</span></code></dt> |
| <dd><p class="first">Command-line to launch the software configuration process. |
| It will be executed in the location specified by the |
| <code class="docutils literal"><span class="pre">BuildDirectory</span></code> setting.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_CONFIGURE_COMMAND"></span><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"><span class="pre">CTEST_CONFIGURE_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-25-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <span class="target" id="index-0-variable:CMAKE_COMMAND"></span><a class="reference internal" href="../variable/CMAKE_COMMAND.html#variable:CMAKE_COMMAND" title="CMAKE_COMMAND"><code class="xref cmake cmake-variable docutils literal"><span class="pre">CMAKE_COMMAND</span></code></a> |
| followed by <span class="target" id="index-1-variable:PROJECT_SOURCE_DIR"></span><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"><span class="pre">PROJECT_SOURCE_DIR</span></code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="ctest-build-step"> |
| <span id="id5"></span><h3>CTest Build Step<a class="headerlink" href="#ctest-build-step" title="Permalink to this headline">¶</a></h3> |
| <p>In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <span class="target" id="index-0-command:ctest_build"></span><a class="reference internal" href="../command/ctest_build.html#command:ctest_build" title="ctest_build"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_build()</span></code></a> command runs this step. |
| Arguments to the command may specify some of the step settings.</p> |
| <p>Configuration settings include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">DefaultCTestConfigurationType</span></code></dt> |
| <dd><p class="first">When the build system to be launched allows build-time selection |
| of the configuration (e.g. <code class="docutils literal"><span class="pre">Debug</span></code>, <code class="docutils literal"><span class="pre">Release</span></code>), this specifies |
| the default configuration to be built when no <code class="docutils literal"><span class="pre">-C</span></code> option is |
| given to the <code class="docutils literal"><span class="pre">ctest</span></code> command. The value will be substituted into |
| the value of <code class="docutils literal"><span class="pre">MakeCommand</span></code> to replace the literal string |
| <code class="docutils literal"><span class="pre">${CTEST_CONFIGURATION_TYPE}</span></code> if it appears.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_CONFIGURATION_TYPE"></span><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"><span class="pre">CTEST_CONFIGURATION_TYPE</span></code></a></li> |
| <li><span class="target" id="index-26-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">DEFAULT_CTEST_CONFIGURATION_TYPE</span></code>, |
| initialized by the <code class="docutils literal"><span class="pre">CMAKE_CONFIG_TYPE</span></code> environment variable</li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">MakeCommand</span></code></dt> |
| <dd><p class="first">Command-line to launch the software build process. |
| It will be executed in the location specified by the |
| <code class="docutils literal"><span class="pre">BuildDirectory</span></code> setting.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_BUILD_COMMAND"></span><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"><span class="pre">CTEST_BUILD_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-27-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">MAKECOMMAND</span></code>, |
| initialized by the <span class="target" id="index-0-command:build_command"></span><a class="reference internal" href="../command/build_command.html#command:build_command" title="build_command"><code class="xref cmake cmake-command docutils literal"><span class="pre">build_command()</span></code></a> command</li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">UseLaunchers</span></code></dt> |
| <dd><p class="first">For build trees generated by CMake using one of the |
| <a class="reference internal" href="cmake-generators.7.html#makefile-generators"><span class="std std-ref">Makefile Generators</span></a> or the <span class="target" id="index-0-generator:Ninja"></span><a class="reference internal" href="../generator/Ninja.html#generator:Ninja" title="Ninja"><code class="xref cmake cmake-generator docutils literal"><span class="pre">Ninja</span></code></a> |
| generator, specify whether the |
| <code class="docutils literal"><span class="pre">CTEST_USE_LAUNCHERS</span></code> feature is enabled by the |
| <span class="target" id="index-0-module:CTestUseLaunchers"></span><a class="reference internal" href="../module/CTestUseLaunchers.html#module:CTestUseLaunchers" title="CTestUseLaunchers"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTestUseLaunchers</span></code></a> module (also included by the |
| <span class="target" id="index-28-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module). When enabled, the generated build |
| system wraps each invocation of the compiler, linker, or |
| custom command line with a “launcher” that communicates |
| with CTest via environment variables and files to report |
| granular build warning and error information. Otherwise, |
| CTest must “scrape” the build output log for diagnostics.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_USE_LAUNCHERS"></span><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"><span class="pre">CTEST_USE_LAUNCHERS</span></code></a></li> |
| <li><span class="target" id="index-29-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_USE_LAUNCHERS</span></code></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="ctest-test-step"> |
| <span id="id6"></span><h3>CTest Test Step<a class="headerlink" href="#ctest-test-step" title="Permalink to this headline">¶</a></h3> |
| <p>In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <span class="target" id="index-0-command:ctest_test"></span><a class="reference internal" href="../command/ctest_test.html#command:ctest_test" title="ctest_test"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_test()</span></code></a> command runs this step. |
| Arguments to the command may specify some of the step settings.</p> |
| <p>Configuration settings include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">TestLoad</span></code></dt> |
| <dd><p class="first">While running tests in parallel (e.g. with <code class="docutils literal"><span class="pre">-j</span></code>), try not to start |
| tests when they may cause the CPU load to pass above a given threshold.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_TEST_LOAD"></span><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"><span class="pre">CTEST_TEST_LOAD</span></code></a></li> |
| <li><span class="target" id="index-30-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_TEST_LOAD</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">TimeOut</span></code></dt> |
| <dd><p class="first">The default timeout for each test if not specified by the |
| <span class="target" id="index-0-prop_test:TIMEOUT"></span><a class="reference internal" href="../prop_test/TIMEOUT.html#prop_test:TIMEOUT" title="TIMEOUT"><code class="xref cmake cmake-prop_test docutils literal"><span class="pre">TIMEOUT</span></code></a> test property.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_TEST_TIMEOUT"></span><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"><span class="pre">CTEST_TEST_TIMEOUT</span></code></a></li> |
| <li><span class="target" id="index-31-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">DART_TESTING_TIMEOUT</span></code></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="ctest-coverage-step"> |
| <span id="id7"></span><h3>CTest Coverage Step<a class="headerlink" href="#ctest-coverage-step" title="Permalink to this headline">¶</a></h3> |
| <p>In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <span class="target" id="index-0-command:ctest_coverage"></span><a class="reference internal" href="../command/ctest_coverage.html#command:ctest_coverage" title="ctest_coverage"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_coverage()</span></code></a> command runs this step. |
| Arguments to the command may specify some of the step settings.</p> |
| <p>Configuration settings include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">CoverageCommand</span></code></dt> |
| <dd><p class="first">Command-line tool to perform software coverage analysis. |
| It will be executed in the location specified by the |
| <code class="docutils literal"><span class="pre">BuildDirectory</span></code> setting.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_COVERAGE_COMMAND"></span><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"><span class="pre">CTEST_COVERAGE_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-32-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">COVERAGE_COMMAND</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">CoverageExtraFlags</span></code></dt> |
| <dd><p class="first">Specify command-line options to the <code class="docutils literal"><span class="pre">CoverageCommand</span></code> tool.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_COVERAGE_EXTRA_FLAGS"></span><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"><span class="pre">CTEST_COVERAGE_EXTRA_FLAGS</span></code></a></li> |
| <li><span class="target" id="index-33-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">COVERAGE_EXTRA_FLAGS</span></code></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="ctest-memcheck-step"> |
| <span id="id8"></span><h3>CTest MemCheck Step<a class="headerlink" href="#ctest-memcheck-step" title="Permalink to this headline">¶</a></h3> |
| <p>In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <span class="target" id="index-0-command:ctest_memcheck"></span><a class="reference internal" href="../command/ctest_memcheck.html#command:ctest_memcheck" title="ctest_memcheck"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_memcheck()</span></code></a> command runs this step. |
| Arguments to the command may specify some of the step settings.</p> |
| <p>Configuration settings include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">MemoryCheckCommand</span></code></dt> |
| <dd><p class="first">Command-line tool to perform dynamic analysis. Test command lines |
| will be launched through this tool.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_MEMORYCHECK_COMMAND"></span><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"><span class="pre">CTEST_MEMORYCHECK_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-34-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">MEMORYCHECK_COMMAND</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">MemoryCheckCommandOptions</span></code></dt> |
| <dd><p class="first">Specify command-line options to the <code class="docutils literal"><span class="pre">MemoryCheckCommand</span></code> tool. |
| They will be placed prior to the test command line.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_MEMORYCHECK_COMMAND_OPTIONS"></span><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"><span class="pre">CTEST_MEMORYCHECK_COMMAND_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-35-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">MEMORYCHECK_COMMAND_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">MemoryCheckType</span></code></dt> |
| <dd><p class="first">Specify the type of memory checking to perform.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_MEMORYCHECK_TYPE"></span><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"><span class="pre">CTEST_MEMORYCHECK_TYPE</span></code></a></li> |
| <li><span class="target" id="index-36-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">MEMORYCHECK_TYPE</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">MemoryCheckSanitizerOptions</span></code></dt> |
| <dd><p class="first">Specify options to sanitizers when running with a sanitize-enabled build.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_MEMORYCHECK_SANITIZER_OPTIONS"></span><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"><span class="pre">CTEST_MEMORYCHECK_SANITIZER_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-37-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">MEMORYCHECK_SANITIZER_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">MemoryCheckSuppressionFile</span></code></dt> |
| <dd><p class="first">Specify a file containing suppression rules for the |
| <code class="docutils literal"><span class="pre">MemoryCheckCommand</span></code> tool. It will be passed with options |
| appropriate to the tool.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_MEMORYCHECK_SUPPRESSIONS_FILE"></span><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"><span class="pre">CTEST_MEMORYCHECK_SUPPRESSIONS_FILE</span></code></a></li> |
| <li><span class="target" id="index-38-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">MEMORYCHECK_SUPPRESSIONS_FILE</span></code></li> |
| </ul> |
| </dd> |
| </dl> |
| <p>Additional configuration settings include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">BoundsCheckerCommand</span></code></dt> |
| <dd><p class="first">Specify a <code class="docutils literal"><span class="pre">MemoryCheckCommand</span></code> that is known to be command-line |
| compatible with Bounds Checker.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li> |
| <li><span class="target" id="index-39-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: none</li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">PurifyCommand</span></code></dt> |
| <dd><p class="first">Specify a <code class="docutils literal"><span class="pre">MemoryCheckCommand</span></code> that is known to be command-line |
| compatible with Purify.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li> |
| <li><span class="target" id="index-40-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">PURIFYCOMMAND</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">ValgrindCommand</span></code></dt> |
| <dd><p class="first">Specify a <code class="docutils literal"><span class="pre">MemoryCheckCommand</span></code> that is known to be command-line |
| compatible with Valgrind.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li> |
| <li><span class="target" id="index-41-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">VALGRIND_COMMAND</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">ValgrindCommandOptions</span></code></dt> |
| <dd><p class="first">Specify command-line options to the <code class="docutils literal"><span class="pre">ValgrindCommand</span></code> tool. |
| They will be placed prior to the test command line.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none</li> |
| <li><span class="target" id="index-42-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">VALGRIND_COMMAND_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="ctest-submit-step"> |
| <span id="id9"></span><h3>CTest Submit Step<a class="headerlink" href="#ctest-submit-step" title="Permalink to this headline">¶</a></h3> |
| <p>In a <a class="reference internal" href="#ctest-script">CTest Script</a>, the <span class="target" id="index-0-command:ctest_submit"></span><a class="reference internal" href="../command/ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_submit()</span></code></a> command runs this step. |
| Arguments to the command may specify some of the step settings.</p> |
| <p>Configuration settings include:</p> |
| <dl class="docutils"> |
| <dt><code class="docutils literal"><span class="pre">BuildName</span></code></dt> |
| <dd><p class="first">Describe the dashboard client platform with a short string. |
| (Operating system, compiler, etc.)</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_BUILD_NAME"></span><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"><span class="pre">CTEST_BUILD_NAME</span></code></a></li> |
| <li><span class="target" id="index-43-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">BUILDNAME</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">CDashVersion</span></code></dt> |
| <dd><p class="first">Specify the version of <a class="reference external" href="http://cdash.org/">CDash</a> on the server.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none, detected from server</li> |
| <li><span class="target" id="index-44-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_CDASH_VERSION</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">CTestSubmitRetryCount</span></code></dt> |
| <dd><p class="first">Specify a number of attempts to retry submission on network failure.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none, |
| use the <span class="target" id="index-1-command:ctest_submit"></span><a class="reference internal" href="../command/ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_submit()</span></code></a> <code class="docutils literal"><span class="pre">RETRY_COUNT</span></code> option.</li> |
| <li><span class="target" id="index-45-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_SUBMIT_RETRY_COUNT</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">CTestSubmitRetryDelay</span></code></dt> |
| <dd><p class="first">Specify a delay before retrying submission on network failure.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: none, |
| use the <span class="target" id="index-2-command:ctest_submit"></span><a class="reference internal" href="../command/ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal"><span class="pre">ctest_submit()</span></code></a> <code class="docutils literal"><span class="pre">RETRY_DELAY</span></code> option.</li> |
| <li><span class="target" id="index-46-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_SUBMIT_RETRY_DELAY</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">CurlOptions</span></code></dt> |
| <dd><p class="first">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"><span class="pre">CURLOPT_SSL_VERIFYPEER_OFF</span></code> |
| and <code class="docutils literal"><span class="pre">CURLOPT_SSL_VERIFYHOST_OFF</span></code>.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_CURL_OPTIONS"></span><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"><span class="pre">CTEST_CURL_OPTIONS</span></code></a></li> |
| <li><span class="target" id="index-47-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_CURL_OPTIONS</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">DropLocation</span></code></dt> |
| <dd><p class="first">The path on the dashboard server to send the submission.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_DROP_LOCATION"></span><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"><span class="pre">CTEST_DROP_LOCATION</span></code></a></li> |
| <li><span class="target" id="index-48-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">DROP_LOCATION</span></code> if set, |
| else <code class="docutils literal"><span class="pre">CTEST_DROP_LOCATION</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">DropMethod</span></code></dt> |
| <dd><p class="first">Specify the method by which results should be submitted to the |
| dashboard server. The value may be <code class="docutils literal"><span class="pre">cp</span></code>, <code class="docutils literal"><span class="pre">ftp</span></code>, <code class="docutils literal"><span class="pre">http</span></code>, |
| <code class="docutils literal"><span class="pre">https</span></code>, <code class="docutils literal"><span class="pre">scp</span></code>, or <code class="docutils literal"><span class="pre">xmlrpc</span></code> (if CMake was built with |
| support for it).</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_DROP_METHOD"></span><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"><span class="pre">CTEST_DROP_METHOD</span></code></a></li> |
| <li><span class="target" id="index-49-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">DROP_METHOD</span></code> if set, |
| else <code class="docutils literal"><span class="pre">CTEST_DROP_METHOD</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">DropSite</span></code></dt> |
| <dd><p class="first">The dashboard server name |
| (for <code class="docutils literal"><span class="pre">ftp</span></code>, <code class="docutils literal"><span class="pre">http</span></code>, and <code class="docutils literal"><span class="pre">https</span></code>, <code class="docutils literal"><span class="pre">scp</span></code>, and <code class="docutils literal"><span class="pre">xmlrpc</span></code>).</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_DROP_SITE"></span><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"><span class="pre">CTEST_DROP_SITE</span></code></a></li> |
| <li><span class="target" id="index-50-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">DROP_SITE</span></code> if set, |
| else <code class="docutils literal"><span class="pre">CTEST_DROP_SITE</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">DropSitePassword</span></code></dt> |
| <dd><p class="first">The dashboard server login password, if any |
| (for <code class="docutils literal"><span class="pre">ftp</span></code>, <code class="docutils literal"><span class="pre">http</span></code>, and <code class="docutils literal"><span class="pre">https</span></code>).</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_DROP_SITE_PASSWORD"></span><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"><span class="pre">CTEST_DROP_SITE_PASSWORD</span></code></a></li> |
| <li><span class="target" id="index-51-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">DROP_SITE_PASSWORD</span></code> if set, |
| else <code class="docutils literal"><span class="pre">CTEST_DROP_SITE_PASWORD</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">DropSiteUser</span></code></dt> |
| <dd><p class="first">The dashboard server login user name, if any |
| (for <code class="docutils literal"><span class="pre">ftp</span></code>, <code class="docutils literal"><span class="pre">http</span></code>, and <code class="docutils literal"><span class="pre">https</span></code>).</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_DROP_SITE_USER"></span><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"><span class="pre">CTEST_DROP_SITE_USER</span></code></a></li> |
| <li><span class="target" id="index-52-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">DROP_SITE_USER</span></code> if set, |
| else <code class="docutils literal"><span class="pre">CTEST_DROP_SITE_USER</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">IsCDash</span></code></dt> |
| <dd><p class="first">Specify whether the dashboard server is <a class="reference external" href="http://cdash.org/">CDash</a> or an older |
| dashboard server implementation requiring <code class="docutils literal"><span class="pre">TriggerSite</span></code>.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_DROP_SITE_CDASH"></span><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"><span class="pre">CTEST_DROP_SITE_CDASH</span></code></a></li> |
| <li><span class="target" id="index-53-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">CTEST_DROP_SITE_CDASH</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">ScpCommand</span></code></dt> |
| <dd><p class="first"><code class="docutils literal"><span class="pre">scp</span></code> command-line tool to use when <code class="docutils literal"><span class="pre">DropMethod</span></code> is <code class="docutils literal"><span class="pre">scp</span></code>.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_SCP_COMMAND"></span><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"><span class="pre">CTEST_SCP_COMMAND</span></code></a></li> |
| <li><span class="target" id="index-54-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">SCPCOMMAND</span></code></li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">Site</span></code></dt> |
| <dd><p class="first">Describe the dashboard client host site with a short string. |
| (Hostname, domain, etc.)</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_SITE"></span><a class="reference internal" href="../variable/CTEST_SITE.html#variable:CTEST_SITE" title="CTEST_SITE"><code class="xref cmake cmake-variable docutils literal"><span class="pre">CTEST_SITE</span></code></a></li> |
| <li><span class="target" id="index-55-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">SITE</span></code>, |
| initialized by the <span class="target" id="index-0-command:site_name"></span><a class="reference internal" href="../command/site_name.html#command:site_name" title="site_name"><code class="xref cmake cmake-command docutils literal"><span class="pre">site_name()</span></code></a> command</li> |
| </ul> |
| </dd> |
| <dt><code class="docutils literal"><span class="pre">TriggerSite</span></code></dt> |
| <dd><p class="first">Legacy option to support older dashboard server implementations. |
| Not used when <code class="docutils literal"><span class="pre">IsCDash</span></code> is true.</p> |
| <ul class="last simple"> |
| <li><a class="reference internal" href="#ctest-script">CTest Script</a> variable: <span class="target" id="index-0-variable:CTEST_TRIGGER_SITE"></span><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"><span class="pre">CTEST_TRIGGER_SITE</span></code></a></li> |
| <li><span class="target" id="index-56-module:CTest"></span><a class="reference internal" href="../module/CTest.html#module:CTest" title="CTest"><code class="xref cmake cmake-module docutils literal"><span class="pre">CTest</span></code></a> module variable: <code class="docutils literal"><span class="pre">TRIGGER_SITE</span></code> if set, |
| else <code class="docutils literal"><span class="pre">CTEST_TRIGGER_SITE</span></code></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="section" id="see-also"> |
| <h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2> |
| <p>The following resources are available to get help using CMake:</p> |
| <dl class="docutils"> |
| <dt>Home Page</dt> |
| <dd><p class="first"><a class="reference external" href="https://cmake.org">https://cmake.org</a></p> |
| <p class="last">The primary starting point for learning about CMake.</p> |
| </dd> |
| <dt>Frequently Asked Questions</dt> |
| <dd><p class="first"><a class="reference external" href="https://cmake.org/Wiki/CMake_FAQ">https://cmake.org/Wiki/CMake_FAQ</a></p> |
| <p class="last">A Wiki is provided containing answers to frequently asked questions.</p> |
| </dd> |
| <dt>Online Documentation</dt> |
| <dd><p class="first"><a class="reference external" href="https://cmake.org/documentation">https://cmake.org/documentation</a></p> |
| <p class="last">Links to available documentation may be found on this web page.</p> |
| </dd> |
| <dt>Mailing List</dt> |
| <dd><p class="first"><a class="reference external" href="https://cmake.org/mailing-lists">https://cmake.org/mailing-lists</a></p> |
| <p class="last">For help and discussion about using cmake, a mailing list is |
| provided at <a class="reference external" href="mailto:cmake%40cmake.org">cmake<span>@</span>cmake<span>.</span>org</a>. The list is member-post-only but one |
| may sign up on the CMake web page. Please first read the full |
| documentation at <a class="reference external" href="https://cmake.org">https://cmake.org</a> before posting questions to |
| the list.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <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="#options">Options</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="#see-also">See Also</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| <h4>Previous topic</h4> |
| <p class="topless"><a href="cmake.1.html" |
| title="previous chapter">cmake(1)</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="cpack.1.html" |
| title="next chapter">cpack(1)</a></p> |
| <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>Quick search</h3> |
| <form class="search" action="../search.html" method="get"> |
| <div><input type="text" name="q" /></div> |
| <div><input type="submit" value="Go" /></div> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| <script type="text/javascript">$('#searchbox').show(0);</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> » |
| </li> |
| <li> |
| <a href="../index.html">3.8.2 Documentation</a> » |
| </li> |
| |
| </ul> |
| </div> |
| <div class="footer" role="contentinfo"> |
| © Copyright 2000-2017 Kitware, Inc. and Contributors. |
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2. |
| </div> |
| </body> |
| </html> |
