blob: a96f2827bf31f0ba9a310cfcddfd19ab1f383a87 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>LINK_WHAT_YOU_USE &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="LINKER_LANGUAGE" href="LINKER_LANGUAGE.html" />
<link rel="prev" title="LINK_SEARCH_START_STATIC" href="LINK_SEARCH_START_STATIC.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="LINKER_LANGUAGE.html" title="LINKER_LANGUAGE"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="LINK_SEARCH_START_STATIC.html" title="LINK_SEARCH_START_STATIC"
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-properties.7.html" accesskey="U">cmake-properties(7)</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">LINK_WHAT_YOU_USE</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="link-what-you-use">
<span id="prop_tgt:LINK_WHAT_YOU_USE"></span><h1>LINK_WHAT_YOU_USE<a class="headerlink" href="#link-what-you-use" title="Permalink to this headline">ΒΆ</a></h1>
<div class="versionadded">
<p><span class="versionmodified added">New in version 3.7.</span></p>
</div>
<p>This is a boolean option that, when set to <code class="docutils literal notranslate"><span class="pre">TRUE</span></code>, will automatically run
contents of variable <span class="target" id="index-0-variable:CMAKE_LINK_WHAT_YOU_USE_CHECK"></span><a class="reference internal" href="../variable/CMAKE_LINK_WHAT_YOU_USE_CHECK.html#variable:CMAKE_LINK_WHAT_YOU_USE_CHECK" title="CMAKE_LINK_WHAT_YOU_USE_CHECK"><code class="xref cmake cmake-variable docutils literal notranslate"><span class="pre">CMAKE_LINK_WHAT_YOU_USE_CHECK</span></code></a> on the target
after it is linked. In addition, the linker flag specified by variable
<span class="target" id="index-0-variable:CMAKE_&lt;LANG&gt;_LINK_WHAT_YOU_USE_FLAG"></span><a class="reference internal" href="../variable/CMAKE_LANG_LINK_WHAT_YOU_USE_FLAG.html#variable:CMAKE_&lt;LANG&gt;_LINK_WHAT_YOU_USE_FLAG" title="CMAKE_&lt;LANG&gt;_LINK_WHAT_YOU_USE_FLAG"><code class="xref cmake cmake-variable docutils literal notranslate"><span class="pre">CMAKE_&lt;LANG&gt;_LINK_WHAT_YOU_USE_FLAG</span></code></a> will be passed to the target
with the link command so that all libraries specified on the command line will
be linked into the target. This will result in the link producing a list of
libraries that provide no symbols used by this target but are being linked to
it.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>For now, it is only supported for <code class="docutils literal notranslate"><span class="pre">ELF</span></code> platforms and is only applicable to
executable and shared or module library targets. This property will be
ignored for any other targets and configurations.</p>
</div>
<p>This property is initialized by the value of
the <span class="target" id="index-0-variable:CMAKE_LINK_WHAT_YOU_USE"></span><a class="reference internal" href="../variable/CMAKE_LINK_WHAT_YOU_USE.html#variable:CMAKE_LINK_WHAT_YOU_USE" title="CMAKE_LINK_WHAT_YOU_USE"><code class="xref cmake cmake-variable docutils literal notranslate"><span class="pre">CMAKE_LINK_WHAT_YOU_USE</span></code></a> variable if it is set
when a target is created.</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="LINK_SEARCH_START_STATIC.html"
title="previous chapter">LINK_SEARCH_START_STATIC</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="LINKER_LANGUAGE.html"
title="next chapter">LINKER_LANGUAGE</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/prop_tgt/LINK_WHAT_YOU_USE.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="LINKER_LANGUAGE.html" title="LINKER_LANGUAGE"
>next</a> |</li>
<li class="right" >
<a href="LINK_SEARCH_START_STATIC.html" title="LINK_SEARCH_START_STATIC"
>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-properties.7.html" >cmake-properties(7)</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">LINK_WHAT_YOU_USE</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>