| <!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>CMP0003 — 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="CMP0002" href="CMP0002.html" /> |
| <link rel="prev" title="CMP0004" href="CMP0004.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="CMP0002.html" title="CMP0002" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="CMP0004.html" title="CMP0004" |
| 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> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-policies.7.html" accesskey="U">cmake-policies(7)</a> »</li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="cmp0003"> |
| <span id="policy:CMP0003"></span><h1>CMP0003<a class="headerlink" href="#cmp0003" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>Libraries linked via full path no longer produce linker search paths.</p> |
| <p>This policy affects how libraries whose full paths are NOT known are |
| found at link time, but was created due to a change in how CMake deals |
| with libraries whose full paths are known. Consider the code</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">target_link_libraries</span><span class="p">(</span><span class="n">myexe</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">libA</span><span class="o">.</span><span class="n">so</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>CMake 2.4 and below implemented linking to libraries whose full paths |
| are known by splitting them on the link line into separate components |
| consisting of the linker search path and the library name. The |
| example code might have produced something like</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="o">-</span><span class="n">L</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span> <span class="o">-</span><span class="n">lA</span> <span class="o">...</span> |
| </pre></div> |
| </div> |
| <p>in order to link to library A. An analysis was performed to order |
| multiple link directories such that the linker would find library A in |
| the desired location, but there are cases in which this does not work. |
| CMake versions 2.6 and above use the more reliable approach of passing |
| the full path to libraries directly to the linker in most cases. The |
| example code now produces something like</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">libA</span><span class="o">.</span><span class="n">so</span> <span class="o">....</span> |
| </pre></div> |
| </div> |
| <p>Unfortunately this change can break code like</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">target_link_libraries</span><span class="p">(</span><span class="n">myexe</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">libA</span><span class="o">.</span><span class="n">so</span> <span class="n">B</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>where “B” is meant to find “/path/to/libB.so”. This code is wrong |
| because the user is asking the linker to find library B but has not |
| provided a linker search path (which may be added with the |
| link_directories command). However, with the old linking |
| implementation the code would work accidentally because the linker |
| search path added for library A allowed library B to be found.</p> |
| <p>In order to support projects depending on linker search paths added by |
| linking to libraries with known full paths, the OLD behavior for this |
| policy will add the linker search paths even though they are not |
| needed for their own libraries. When this policy is set to OLD, CMake |
| will produce a link line such as</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="o">-</span><span class="n">L</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">libA</span><span class="o">.</span><span class="n">so</span> <span class="o">-</span><span class="n">lB</span> <span class="o">...</span> |
| </pre></div> |
| </div> |
| <p>which will allow library B to be found as it was previously. When |
| this policy is set to NEW, CMake will produce a link line such as</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">...</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">libA</span><span class="o">.</span><span class="n">so</span> <span class="o">-</span><span class="n">lB</span> <span class="o">...</span> |
| </pre></div> |
| </div> |
| <p>which more accurately matches what the project specified.</p> |
| <p>The setting for this policy used when generating the link line is that |
| in effect when the target is created by an add_executable or |
| add_library command. For the example described above, the code</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cmake_policy</span><span class="p">(</span><span class="n">SET</span> <span class="n">CMP0003</span> <span class="n">OLD</span><span class="p">)</span> <span class="c1"># or cmake_policy(VERSION 2.4)</span> |
| <span class="n">add_executable</span><span class="p">(</span><span class="n">myexe</span> <span class="n">myexe</span><span class="o">.</span><span class="n">c</span><span class="p">)</span> |
| <span class="n">target_link_libraries</span><span class="p">(</span><span class="n">myexe</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">libA</span><span class="o">.</span><span class="n">so</span> <span class="n">B</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>will work and suppress the warning for this policy. It may also be |
| updated to work with the corrected linking approach:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cmake_policy</span><span class="p">(</span><span class="n">SET</span> <span class="n">CMP0003</span> <span class="n">NEW</span><span class="p">)</span> <span class="c1"># or cmake_policy(VERSION 2.6)</span> |
| <span class="n">link_directories</span><span class="p">(</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="p">)</span> <span class="c1"># needed to find library B</span> |
| <span class="n">add_executable</span><span class="p">(</span><span class="n">myexe</span> <span class="n">myexe</span><span class="o">.</span><span class="n">c</span><span class="p">)</span> |
| <span class="n">target_link_libraries</span><span class="p">(</span><span class="n">myexe</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">libA</span><span class="o">.</span><span class="n">so</span> <span class="n">B</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Even better, library B may be specified with a full path:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">add_executable</span><span class="p">(</span><span class="n">myexe</span> <span class="n">myexe</span><span class="o">.</span><span class="n">c</span><span class="p">)</span> |
| <span class="n">target_link_libraries</span><span class="p">(</span><span class="n">myexe</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">libA</span><span class="o">.</span><span class="n">so</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">libB</span><span class="o">.</span><span class="n">so</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>When all items on the link line have known paths CMake does not check |
| this policy so it has no effect.</p> |
| <p>Note that the warning for this policy will be issued for at most one |
| target. This avoids flooding users with messages for every target |
| when setting the policy once will probably fix all targets.</p> |
| <p>This policy was introduced in CMake version 2.6.0. CMake version |
| 3.8.2 warns when the policy is not set and uses OLD behavior. Use |
| the cmake_policy command to set it to OLD or NEW explicitly.</p> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p class="last">The <code class="docutils literal"><span class="pre">OLD</span></code> behavior of a policy is |
| <span class="target" id="index-0-manual:cmake-policies(7)"></span><a class="reference internal" href="../manual/cmake-policies.7.html#manual:cmake-policies(7)" title="cmake-policies(7)"><code class="xref cmake cmake-manual docutils literal"><span class="pre">deprecated</span> <span class="pre">by</span> <span class="pre">definition</span></code></a> |
| and may be removed in a future version of CMake.</p> |
| </div> |
| </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="CMP0004.html" |
| title="previous chapter">CMP0004</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="CMP0002.html" |
| title="next chapter">CMP0002</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/policy/CMP0003.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="CMP0002.html" title="CMP0002" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="CMP0004.html" title="CMP0004" |
| >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> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-policies.7.html" >cmake-policies(7)</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> |