| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="../"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>cmake plugin — BuildStream Plugins 2.2.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" /> |
| <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" /> |
| |
| |
| <!--[if lt IE 9]> |
| <script src="../_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| <script src="../_static/jquery.js?v=5d32c60e"></script> |
| <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="../_static/documentation_options.js?v=b21de401"></script> |
| <script src="../_static/doctools.js?v=9a2dae69"></script> |
| <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="../_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="make plugin" href="make.html" /> |
| <link rel="prev" title="autotools plugin" href="autotools.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../index.html" class="icon icon-home"> |
| BuildStream Plugins |
| </a> |
| <div class="version"> |
| 2.2.0 |
| </div> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <p class="caption" role="heading"><span class="caption-text">Element Plugins</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="autotools.html">autotools plugin</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">cmake plugin</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#cmake-cmake-build-element">cmake - CMake build element</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="make.html">make plugin</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="meson.html">meson plugin</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="pip.html">pip plugin</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="setuptools.html">setuptools plugin</a></li> |
| </ul> |
| <p class="caption" role="heading"><span class="caption-text">Source Plugins</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../sources/bzr.html">bzr plugin</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../sources/cargo.html">cargo plugin</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../sources/docker.html">docker plugin</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../sources/git.html">git plugin</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../sources/patch.html">patch plugin</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../sources/pip.html">pip plugin</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">BuildStream Plugins</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item active">cmake plugin</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../_sources/elements/cmake.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="module-elements.cmake"> |
| <span id="cmake-plugin"></span><h1>cmake plugin<a class="headerlink" href="#module-elements.cmake" title="Link to this heading"></a></h1> |
| <section id="cmake-cmake-build-element"> |
| <h2>cmake - CMake build element<a class="headerlink" href="#cmake-cmake-build-element" title="Link to this heading"></a></h2> |
| <p>This is a <a class="reference external" href="https://docs.buildstream.build/master/buildstream.buildelement.html#module-buildstream.buildelement">BuildElement</a> |
| implementation for using the <a class="reference external" href="https://cmake.org/">CMake</a> build system.</p> |
| <p>You will often want to pass additional arguments to the <code class="docutils literal notranslate"><span class="pre">cmake</span></code> program for |
| specific configuration options. This should be done on a per-element basis by |
| setting the <code class="docutils literal notranslate"><span class="pre">cmake-local</span></code> variable. Here is an example:</p> |
| <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">variables</span><span class="p">:</span> |
| <span class="w"> </span><span class="nt">cmake-local</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span> |
| <span class="w"> </span><span class="no">-DCMAKE_BUILD_TYPE=Debug</span> |
| </pre></div> |
| </div> |
| <p>If you want to pass extra options to <code class="docutils literal notranslate"><span class="pre">cmake</span></code> for every element in your |
| project, set the <code class="docutils literal notranslate"><span class="pre">cmake-global</span></code> variable in your project.conf file. Here is |
| an example of that:</p> |
| <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">elements</span><span class="p">:</span> |
| <span class="w"> </span><span class="nt">cmake</span><span class="p">:</span> |
| <span class="w"> </span><span class="nt">variables</span><span class="p">:</span> |
| <span class="w"> </span><span class="nt">cmake-global</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span> |
| <span class="w"> </span><span class="no">-DCMAKE_BUILD_TYPE=Release</span> |
| </pre></div> |
| </div> |
| <p>Here is the default configuration for the <code class="docutils literal notranslate"><span class="pre">cmake</span></code> element in full:</p> |
| <blockquote> |
| <div><div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span> |
| <span class="c1"># you may not use this file except in compliance with the License.</span> |
| <span class="c1"># You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing, software</span> |
| <span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="c1"># See the License for the specific language governing permissions and</span> |
| <span class="c1"># limitations under the License.</span> |
| |
| <span class="c1"># CMake default configuration</span> |
| |
| <span class="nt">variables</span><span class="p">:</span> |
| |
| <span class="w"> </span><span class="nt">build-dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">_builddir</span> |
| |
| <span class="w"> </span><span class="c1"># Project-wide extra arguments to be passed to `cmake`</span> |
| <span class="w"> </span><span class="nt">cmake-global</span><span class="p">:</span><span class="w"> </span><span class="s">''</span> |
| |
| <span class="w"> </span><span class="c1"># Element-specific extra arguments to be passed to `cmake`.</span> |
| <span class="w"> </span><span class="nt">cmake-local</span><span class="p">:</span><span class="w"> </span><span class="s">''</span> |
| |
| <span class="w"> </span><span class="c1"># The cmake generator to use</span> |
| <span class="w"> </span><span class="nt">generator</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Ninja</span> |
| |
| <span class="w"> </span><span class="nt">cmake-args</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span> |
| |
| <span class="w"> </span><span class="no">-DCMAKE_VERBOSE_MAKEFILE=ON \</span> |
| <span class="w"> </span><span class="no">-DCMAKE_INSTALL_PREFIX:PATH="%{prefix}" \</span> |
| <span class="w"> </span><span class="no">-DCMAKE_INSTALL_LIBDIR:PATH="%{lib}" %{cmake-global} %{cmake-local}</span> |
| |
| <span class="w"> </span><span class="nt">cmake</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span> |
| |
| <span class="w"> </span><span class="no">cmake -B%{build-dir} -H"%{conf-root}" -G"%{generator}" %{cmake-args}</span> |
| |
| <span class="w"> </span><span class="nt">make</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">cmake --build %{build-dir} -- ${JOBS}</span> |
| <span class="w"> </span><span class="nt">make-install</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">env DESTDIR="%{install-root}" cmake --build %{build-dir} --target install</span> |
| |
| <span class="w"> </span><span class="c1"># Set this if the sources cannot handle parallelization.</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="c1"># notparallel: True</span> |
| |
| <span class="nt">config</span><span class="p">:</span> |
| |
| <span class="w"> </span><span class="c1"># Commands for configuring the software</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="nt">configure-commands</span><span class="p">:</span> |
| <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="p p-Indicator">|</span> |
| <span class="w"> </span><span class="no">%{cmake}</span> |
| |
| <span class="w"> </span><span class="c1"># Commands for building the software</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="nt">build-commands</span><span class="p">:</span> |
| <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="p p-Indicator">|</span> |
| <span class="w"> </span><span class="no">%{make}</span> |
| |
| <span class="w"> </span><span class="c1"># Commands for installing the software into a</span> |
| <span class="w"> </span><span class="c1"># destination folder</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="nt">install-commands</span><span class="p">:</span> |
| <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="p p-Indicator">|</span> |
| <span class="w"> </span><span class="no">%{make-install}</span> |
| |
| <span class="w"> </span><span class="c1"># Commands for stripping debugging information out of</span> |
| <span class="w"> </span><span class="c1"># installed binaries</span> |
| <span class="w"> </span><span class="c1">#</span> |
| <span class="w"> </span><span class="nt">strip-commands</span><span class="p">:</span> |
| <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="p p-Indicator">|</span> |
| <span class="w"> </span><span class="no">%{strip-binaries}</span> |
| |
| <span class="c1"># Use max-jobs CPUs for building and enable verbosity</span> |
| <span class="nt">environment</span><span class="p">:</span> |
| <span class="w"> </span><span class="nt">JOBS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">-j%{max-jobs}</span> |
| |
| <span class="c1"># And dont consider JOBS as something which may</span> |
| <span class="c1"># affect build output.</span> |
| <span class="nt">environment-nocache</span><span class="p">:</span> |
| <span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">JOBS</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <p>See <a class="reference external" href="https://docs.buildstream.build/master/buildstream.buildelement.html#core-buildelement-builtins">built-in functionality documentation</a> for |
| details on common configuration options for build elements.</p> |
| </section> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="autotools.html" class="btn btn-neutral float-left" title="autotools plugin" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="make.html" class="btn btn-neutral float-right" title="make plugin" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2022, The Apache Software Foundation.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
