simulation-package / toolchain /cmake-3.27.9-linux-x86_64 /doc /cmake /html /command /define_property.html
| <html lang="en"> | |
| <head> | |
| <meta charset="utf-8" /> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> | |
| <title>define_property — CMake 3.27.9 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/_sphinx_javascript_frameworks_compat.js"></script> | |
| <script src="../_static/doctools.js"></script> | |
| <script src="../_static/sphinx_highlight.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="enable_language" href="enable_language.html" /> | |
| <link rel="prev" title="create_test_sourcelist" href="create_test_sourcelist.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="enable_language.html" title="enable_language" | |
| accesskey="N">next</a> |</li> | |
| <li class="right" > | |
| <a href="create_test_sourcelist.html" title="create_test_sourcelist" | |
| 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.27.9 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="">define_property</a></li> | |
| </ul> | |
| </div> | |
| <div class="document"> | |
| <div class="documentwrapper"> | |
| <div class="bodywrapper"> | |
| <div class="body" role="main"> | |
| <section id="define-property"> | |
| <span id="command:define_property"></span><h1>define_property<a class="headerlink" href="#define-property" title="Permalink to this heading">¶</a></h1> | |
| <p>Define and document custom properties.</p> | |
| <div class="highlight-cmake notranslate"><div class="highlight"><pre><span></span><span class="nf">define_property(</span><span class="o"><</span><span class="no">GLOBAL</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="no">DIRECTORY</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="no">TARGET</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="no">SOURCE</span><span class="w"> </span><span class="p">|</span> | |
| <span class="w"> </span><span class="no">TEST</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="no">VARIABLE</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="no">CACHED_VARIABLE</span><span class="o">></span> | |
| <span class="w"> </span><span class="no">PROPERTY</span><span class="w"> </span><span class="nv"><name></span><span class="w"> </span><span class="p">[</span><span class="no">INHERITED</span><span class="p">]</span> | |
| <span class="w"> </span><span class="p">[</span><span class="no">BRIEF_DOCS</span><span class="w"> </span><span class="nv"><brief-doc></span><span class="w"> </span><span class="p">[</span><span class="nb">docs...</span><span class="p">]]</span> | |
| <span class="w"> </span><span class="p">[</span><span class="no">FULL_DOCS</span><span class="w"> </span><span class="nv"><full-doc></span><span class="w"> </span><span class="p">[</span><span class="nb">docs...</span><span class="p">]]</span> | |
| <span class="w"> </span><span class="p">[</span><span class="no">INITIALIZE_FROM_VARIABLE</span><span class="w"> </span><span class="nv"><variable></span><span class="p">]</span><span class="nf">)</span> | |
| </pre></div> | |
| </div> | |
| <p>Defines one property in a scope for use with the <span class="target" id="index-0-command:set_property"></span><a class="reference internal" href="set_property.html#command:set_property" title="set_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">set_property()</span></code></a> and | |
| <span class="target" id="index-0-command:get_property"></span><a class="reference internal" href="get_property.html#command:get_property" title="get_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_property()</span></code></a> commands. It is mainly useful for defining the way | |
| a property is initialized or inherited. Historically, the command also | |
| associated documentation with a property, but that is no longer considered a | |
| primary use case.</p> | |
| <p>The first argument determines the kind of scope in which the property should | |
| be used. It must be one of the following:</p> | |
| <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>GLOBAL = associated with the global namespace | |
| DIRECTORY = associated with one directory | |
| TARGET = associated with one target | |
| SOURCE = associated with one source file | |
| TEST = associated with a test named with add_test | |
| VARIABLE = documents a CMake language variable | |
| CACHED_VARIABLE = documents a CMake cache variable | |
| </pre></div> | |
| </div> | |
| <p>Note that unlike <span class="target" id="index-1-command:set_property"></span><a class="reference internal" href="set_property.html#command:set_property" title="set_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">set_property()</span></code></a> and <span class="target" id="index-1-command:get_property"></span><a class="reference internal" href="get_property.html#command:get_property" title="get_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_property()</span></code></a> no | |
| actual scope needs to be given; only the kind of scope is important.</p> | |
| <p>The required <code class="docutils literal notranslate"><span class="pre">PROPERTY</span></code> option is immediately followed by the name of | |
| the property being defined.</p> | |
| <p>If the <code class="docutils literal notranslate"><span class="pre">INHERITED</span></code> option is given, then the <span class="target" id="index-2-command:get_property"></span><a class="reference internal" href="get_property.html#command:get_property" title="get_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_property()</span></code></a> command | |
| will chain up to the next higher scope when the requested property is not set | |
| in the scope given to the command.</p> | |
| <ul class="simple"> | |
| <li><p><code class="docutils literal notranslate"><span class="pre">DIRECTORY</span></code> scope chains to its parent directory's scope, continuing the | |
| walk up parent directories until a directory has the property set or there | |
| are no more parents. If still not found at the top level directory, it | |
| chains to the <code class="docutils literal notranslate"><span class="pre">GLOBAL</span></code> scope.</p></li> | |
| <li><p><code class="docutils literal notranslate"><span class="pre">TARGET</span></code>, <code class="docutils literal notranslate"><span class="pre">SOURCE</span></code> and <code class="docutils literal notranslate"><span class="pre">TEST</span></code> properties chain to <code class="docutils literal notranslate"><span class="pre">DIRECTORY</span></code> scope, | |
| including further chaining up the directories, etc. as needed.</p></li> | |
| </ul> | |
| <p>Note that this scope chaining behavior only applies to calls to | |
| <span class="target" id="index-3-command:get_property"></span><a class="reference internal" href="get_property.html#command:get_property" title="get_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_property()</span></code></a>, <span class="target" id="index-0-command:get_directory_property"></span><a class="reference internal" href="get_directory_property.html#command:get_directory_property" title="get_directory_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_directory_property()</span></code></a>, | |
| <span class="target" id="index-0-command:get_target_property"></span><a class="reference internal" href="get_target_property.html#command:get_target_property" title="get_target_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_target_property()</span></code></a>, <span class="target" id="index-0-command:get_source_file_property"></span><a class="reference internal" href="get_source_file_property.html#command:get_source_file_property" title="get_source_file_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_source_file_property()</span></code></a> and | |
| <span class="target" id="index-0-command:get_test_property"></span><a class="reference internal" href="get_test_property.html#command:get_test_property" title="get_test_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_test_property()</span></code></a>. There is no inheriting behavior when <em>setting</em> | |
| properties, so using <code class="docutils literal notranslate"><span class="pre">APPEND</span></code> or <code class="docutils literal notranslate"><span class="pre">APPEND_STRING</span></code> with the | |
| <span class="target" id="index-2-command:set_property"></span><a class="reference internal" href="set_property.html#command:set_property" title="set_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">set_property()</span></code></a> command will not consider inherited values when working | |
| out the contents to append to.</p> | |
| <p>The <code class="docutils literal notranslate"><span class="pre">BRIEF_DOCS</span></code> and <code class="docutils literal notranslate"><span class="pre">FULL_DOCS</span></code> options are followed by strings to be | |
| associated with the property as its brief and full documentation. | |
| CMake does not use this documentation other than making it available to the | |
| project via corresponding options to the <span class="target" id="index-4-command:get_property"></span><a class="reference internal" href="get_property.html#command:get_property" title="get_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_property()</span></code></a> command.</p> | |
| <div class="versionchanged"> | |
| <p><span class="versionmodified changed">Changed in version 3.23: </span>The <code class="docutils literal notranslate"><span class="pre">BRIEF_DOCS</span></code> and <code class="docutils literal notranslate"><span class="pre">FULL_DOCS</span></code> options are optional.</p> | |
| </div> | |
| <div class="versionadded"> | |
| <p><span class="versionmodified added">New in version 3.23: </span>The <code class="docutils literal notranslate"><span class="pre">INITIALIZE_FROM_VARIABLE</span></code> option specifies a variable from which the | |
| property should be initialized. It can only be used with target properties. | |
| The <code class="docutils literal notranslate"><span class="pre"><variable></span></code> name must end with the property name and must not begin | |
| with <code class="docutils literal notranslate"><span class="pre">CMAKE_</span></code> or <code class="docutils literal notranslate"><span class="pre">_CMAKE_</span></code>. The property name must contain at least one | |
| underscore. It is recommended that the property name have a prefix specific | |
| to the project.</p> | |
| </div> | |
| <section id="see-also"> | |
| <h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this heading">¶</a></h2> | |
| <ul class="simple"> | |
| <li><p><span class="target" id="index-5-command:get_property"></span><a class="reference internal" href="get_property.html#command:get_property" title="get_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">get_property()</span></code></a></p></li> | |
| <li><p><span class="target" id="index-3-command:set_property"></span><a class="reference internal" href="set_property.html#command:set_property" title="set_property"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">set_property()</span></code></a></p></li> | |
| </ul> | |
| </section> | |
| </section> | |
| <div class="clearer"></div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | |
| <div class="sphinxsidebarwrapper"> | |
| <div> | |
| <h3><a href="../index.html">Table of Contents</a></h3> | |
| <ul> | |
| <li><a class="reference internal" href="#">define_property</a><ul> | |
| <li><a class="reference internal" href="#see-also">See Also</a></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| <div> | |
| <h4>Previous topic</h4> | |
| <p class="topless"><a href="create_test_sourcelist.html" | |
| title="previous chapter">create_test_sourcelist</a></p> | |
| </div> | |
| <div> | |
| <h4>Next topic</h4> | |
| <p class="topless"><a href="enable_language.html" | |
| title="next chapter">enable_language</a></p> | |
| </div> | |
| <div role="note" aria-label="source link"> | |
| <h3>This Page</h3> | |
| <ul class="this-page-menu"> | |
| <li><a href="../_sources/command/define_property.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>document.getElementById('searchbox').style.display = "block"</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="enable_language.html" title="enable_language" | |
| >next</a> |</li> | |
| <li class="right" > | |
| <a href="create_test_sourcelist.html" title="create_test_sourcelist" | |
| >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.27.9 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="">define_property</a></li> | |
| </ul> | |
| </div> | |
| <div class="footer" role="contentinfo"> | |
| © Copyright 2000-2023 Kitware, Inc. and Contributors. | |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0. | |
| </div> | |
| </body> | |
| </html> |