doc/cmake/html/command/ctest_memcheck.html - platform/prebuilts/cmake/linux-x86 - Git at Google


 <!DOCTYPE html>

 <html lang="en">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>ctest_memcheck &mdash; CMake 3.23.1 Documentation</title>

     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
     <script src="../_static/jquery.js"></script>
     <script src="../_static/underscore.js"></script>
     <script 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="ctest_read_custom_files" href="ctest_read_custom_files.html" />
     <link rel="prev" title="ctest_empty_binary_directory" href="ctest_empty_binary_directory.html" />


   </head><body>

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

           <li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" accesskey="U">cmake-commands(7)</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">ctest_memcheck</a></li>
       </ul>
     </div>

     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
           <div class="body" role="main">

   <div class="section" id="ctest-memcheck">
 <span id="command:ctest_memcheck"></span><h1>ctest_memcheck<a class="headerlink" href="#ctest-memcheck" title="Permalink to this headline">¶</a></h1>
 <p>Perform the <a class="reference internal" href="../manual/ctest.1.html#ctest-memcheck-step"><span class="std std-ref">CTest MemCheck Step</span></a> as a <a class="reference internal" href="../manual/ctest.1.html#dashboard-client"><span class="std std-ref">Dashboard Client</span></a>.</p>
 <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>ctest_memcheck([BUILD &lt;build-dir&gt;] [APPEND]
                [START &lt;start-number&gt;]
                [END &lt;end-number&gt;]
                [STRIDE &lt;stride-number&gt;]
                [EXCLUDE &lt;exclude-regex&gt;]
                [INCLUDE &lt;include-regex&gt;]
                [EXCLUDE_LABEL &lt;label-exclude-regex&gt;]
                [INCLUDE_LABEL &lt;label-include-regex&gt;]
                [EXCLUDE_FIXTURE &lt;regex&gt;]
                [EXCLUDE_FIXTURE_SETUP &lt;regex&gt;]
                [EXCLUDE_FIXTURE_CLEANUP &lt;regex&gt;]
                [PARALLEL_LEVEL &lt;level&gt;]
                [RESOURCE_SPEC_FILE &lt;file&gt;]
                [TEST_LOAD &lt;threshold&gt;]
                [SCHEDULE_RANDOM &lt;ON|OFF&gt;]
                [STOP_ON_FAILURE]
                [STOP_TIME &lt;time-of-day&gt;]
                [RETURN_VALUE &lt;result-var&gt;]
                [CAPTURE_CMAKE_ERROR &lt;result-var&gt;]
                [REPEAT &lt;mode&gt;:&lt;n&gt;]
                [OUTPUT_JUNIT &lt;file&gt;]
                [DEFECT_COUNT &lt;defect-count-var&gt;]
                [QUIET]
                )
 </pre></div>
 </div>
 <p>Run tests with a dynamic analysis tool and store results in
 <code class="docutils literal notranslate"><span class="pre">MemCheck.xml</span></code> for submission with the <span class="target" id="index-0-command:ctest_submit"></span><a class="reference internal" href="ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">ctest_submit()</span></code></a>
 command.</p>
 <p>Most options are the same as those for the <span class="target" id="index-0-command:ctest_test"></span><a class="reference internal" href="ctest_test.html#command:ctest_test" title="ctest_test"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">ctest_test()</span></code></a> command.</p>
 <p>The options unique to this command are:</p>
 <dl>
 <dt><code class="docutils literal notranslate"><span class="pre">DEFECT_COUNT</span> <span class="pre">&lt;defect-count-var&gt;</span></code></dt><dd><div class="versionadded">
 <p><span class="versionmodified added">New in version 3.8.</span></p>
 </div>
 <p>Store in the <code class="docutils literal notranslate"><span class="pre">&lt;defect-count-var&gt;</span></code> the number of defects found.</p>
 </dd>
 </dl>
 </div>


             <div class="clearer"></div>
           </div>
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
   <h4>Previous topic</h4>
   <p class="topless"><a href="ctest_empty_binary_directory.html"
                         title="previous chapter">ctest_empty_binary_directory</a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="ctest_read_custom_files.html"
                         title="next chapter">ctest_read_custom_files</a></p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
       <li><a href="../_sources/command/ctest_memcheck.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
 <div id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../search.html" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
 </div>
 <script>$('#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="ctest_read_custom_files.html" title="ctest_read_custom_files"
              >next</a> |</li>
         <li class="right" >
           <a href="ctest_empty_binary_directory.html" title="ctest_empty_binary_directory"
              >previous</a> |</li>
   <li>
     <img src="../_static/cmake-logo-16.png" alt=""
          style="vertical-align: middle; margin-top: -2px" />
   </li>
   <li>
     <a href="https://cmake.org/">CMake</a> &#187;
   </li>
   <li>
     <a href="../index.html">3.23.1 Documentation</a> &#187;
   </li>

           <li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" >cmake-commands(7)</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">ctest_memcheck</a></li>
       </ul>
     </div>

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

	<!DOCTYPE html>

	<html lang="en">
	<head>
	<meta charset="utf-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1.0" />
	<title>ctest_memcheck — CMake 3.23.1 Documentation</title>

	<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
	<link rel="stylesheet" type="text/css" href="../_static/cmake.css" />

	<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
	<script src="../_static/jquery.js"></script>
	<script src="../_static/underscore.js"></script>
	<script 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="ctest_read_custom_files" href="ctest_read_custom_files.html" />
	<link rel="prev" title="ctest_empty_binary_directory" href="ctest_empty_binary_directory.html" />


	</head><body>

	<div class="related" role="navigation" aria-label="related navigation">
	<h3>Navigation</h3>
	<ul>
	<li class="right" style="margin-right: 10px">
	<a href="../genindex.html" title="General Index"
	accesskey="I">index</a></li>
	<li class="right" >
	<a href="ctest_read_custom_files.html" title="ctest_read_custom_files"
	accesskey="N">next</a> \|</li>
	<li class="right" >
	<a href="ctest_empty_binary_directory.html" title="ctest_empty_binary_directory"
	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.23.1 Documentation</a> »
	</li>

	<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" accesskey="U">cmake-commands(7)</a> »</li>
	<li class="nav-item nav-item-this"><a href="">ctest_memcheck</a></li>
	</ul>
	</div>

	<div class="document">
	<div class="documentwrapper">
	<div class="bodywrapper">
	<div class="body" role="main">

	<div class="section" id="ctest-memcheck">
	<span id="command:ctest_memcheck"></span><h1>ctest_memcheck<a class="headerlink" href="#ctest-memcheck" title="Permalink to this headline">¶</a></h1>
	<p>Perform the <a class="reference internal" href="../manual/ctest.1.html#ctest-memcheck-step"><span class="std std-ref">CTest MemCheck Step</span></a> as a <a class="reference internal" href="../manual/ctest.1.html#dashboard-client"><span class="std std-ref">Dashboard Client</span></a>.</p>
	<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>ctest_memcheck([BUILD <build-dir>] [APPEND]
	[START <start-number>]
	[END <end-number>]
	[STRIDE <stride-number>]
	[EXCLUDE <exclude-regex>]
	[INCLUDE <include-regex>]
	[EXCLUDE_LABEL <label-exclude-regex>]
	[INCLUDE_LABEL <label-include-regex>]
	[EXCLUDE_FIXTURE <regex>]
	[EXCLUDE_FIXTURE_SETUP <regex>]
	[EXCLUDE_FIXTURE_CLEANUP <regex>]
	[PARALLEL_LEVEL <level>]
	[RESOURCE_SPEC_FILE <file>]
	[TEST_LOAD <threshold>]
	[SCHEDULE_RANDOM <ON\|OFF>]
	[STOP_ON_FAILURE]
	[STOP_TIME <time-of-day>]
	[RETURN_VALUE <result-var>]
	[CAPTURE_CMAKE_ERROR <result-var>]
	[REPEAT <mode>:<n>]
	[OUTPUT_JUNIT <file>]
	[DEFECT_COUNT <defect-count-var>]
	[QUIET]
	)
	</pre></div>
	</div>
	<p>Run tests with a dynamic analysis tool and store results in
	<code class="docutils literal notranslate"><span class="pre">MemCheck.xml</span></code> for submission with the <span class="target" id="index-0-command:ctest_submit"></span><a class="reference internal" href="ctest_submit.html#command:ctest_submit" title="ctest_submit"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">ctest_submit()</span></code></a>
	command.</p>
	<p>Most options are the same as those for the <span class="target" id="index-0-command:ctest_test"></span><a class="reference internal" href="ctest_test.html#command:ctest_test" title="ctest_test"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">ctest_test()</span></code></a> command.</p>
	<p>The options unique to this command are:</p>
	<dl>
	<dt><code class="docutils literal notranslate"><span class="pre">DEFECT_COUNT</span> <span class="pre"><defect-count-var></span></code></dt><dd><div class="versionadded">
	<p><span class="versionmodified added">New in version 3.8.</span></p>
	</div>
	<p>Store in the <code class="docutils literal notranslate"><span class="pre"><defect-count-var></span></code> the number of defects found.</p>
	</dd>
	</dl>
	</div>


	<div class="clearer"></div>
	</div>
	</div>
	</div>
	<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
	<div class="sphinxsidebarwrapper">
	<h4>Previous topic</h4>
	<p class="topless"><a href="ctest_empty_binary_directory.html"
	title="previous chapter">ctest_empty_binary_directory</a></p>
	<h4>Next topic</h4>
	<p class="topless"><a href="ctest_read_custom_files.html"
	title="next chapter">ctest_read_custom_files</a></p>
	<div role="note" aria-label="source link">
	<h3>This Page</h3>
	<ul class="this-page-menu">
	<li><a href="../_sources/command/ctest_memcheck.rst.txt"
	rel="nofollow">Show Source</a></li>
	</ul>
	</div>
	<div id="searchbox" style="display: none" role="search">
	<h3 id="searchlabel">Quick search</h3>
	<div class="searchformwrapper">
	<form class="search" action="../search.html" method="get">
	<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
	<input type="submit" value="Go" />
	</form>
	</div>
	</div>
	<script>$('#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="ctest_read_custom_files.html" title="ctest_read_custom_files"
	>next</a> \|</li>
	<li class="right" >
	<a href="ctest_empty_binary_directory.html" title="ctest_empty_binary_directory"
	>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.23.1 Documentation</a> »
	</li>

	<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" >cmake-commands(7)</a> »</li>
	<li class="nav-item nav-item-this"><a href="">ctest_memcheck</a></li>
	</ul>
	</div>

	<div class="footer" role="contentinfo">
	© Copyright 2000-2022 Kitware, Inc. and Contributors.
	Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2.
	</div>
	</body>
	</html>