| |
| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>ctest_update — 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_upload" href="ctest_upload.html" /> |
| <link rel="prev" title="ctest_test" href="ctest_test.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_upload.html" title="ctest_upload" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="ctest_test.html" title="ctest_test" |
| 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_update</a></li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="ctest-update"> |
| <span id="command:ctest_update"></span><h1>ctest_update<a class="headerlink" href="#ctest-update" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>Perform the <a class="reference internal" href="../manual/ctest.1.html#ctest-update-step"><span class="std std-ref">CTest Update 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_update([SOURCE <source-dir>] |
| [RETURN_VALUE <result-var>] |
| [CAPTURE_CMAKE_ERROR <result-var>] |
| [QUIET]) |
| </pre></div> |
| </div> |
| <p>Update the source tree from version control and record results in |
| <code class="docutils literal notranslate"><span class="pre">Update.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>The options are:</p> |
| <dl> |
| <dt><code class="docutils literal notranslate"><span class="pre">SOURCE</span> <span class="pre"><source-dir></span></code></dt><dd><p>Specify the source directory. If not given, the |
| <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 notranslate"><span class="pre">CTEST_SOURCE_DIRECTORY</span></code></a> variable is used.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">RETURN_VALUE</span> <span class="pre"><result-var></span></code></dt><dd><p>Store in the <code class="docutils literal notranslate"><span class="pre"><result-var></span></code> variable the number of files |
| updated or <code class="docutils literal notranslate"><span class="pre">-1</span></code> on error.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">CAPTURE_CMAKE_ERROR</span> <span class="pre"><result-var></span></code></dt><dd><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.13.</span></p> |
| </div> |
| <p>Store in the <code class="docutils literal notranslate"><span class="pre"><result-var></span></code> variable -1 if there are any errors running |
| the command and prevent ctest from returning non-zero if an error occurs.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">QUIET</span></code></dt><dd><div class="versionadded"> |
| <p><span class="versionmodified added">New in version 3.3.</span></p> |
| </div> |
| <p>Tell CTest to suppress most non-error messages that it would |
| have otherwise printed to the console. CTest will still report |
| the new revision of the repository and any conflicting files |
| that were found.</p> |
| </dd> |
| </dl> |
| <p>The update always follows the version control branch currently checked |
| out in the source directory. See the <a class="reference internal" href="../manual/ctest.1.html#ctest-update-step"><span class="std std-ref">CTest Update Step</span></a> |
| documentation for information about variables that change the behavior |
| of <code class="docutils literal notranslate"><span class="pre">ctest_update()</span></code>.</p> |
| </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_test.html" |
| title="previous chapter">ctest_test</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="ctest_upload.html" |
| title="next chapter">ctest_upload</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/command/ctest_update.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_upload.html" title="ctest_upload" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="ctest_test.html" title="ctest_test" |
| >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_update</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> |