diff options
Diffstat (limited to 'src/buildstream/plugins/elements/cmake.py')
-rw-r--r-- | src/buildstream/plugins/elements/cmake.py | 74 |
1 files changed, 0 insertions, 74 deletions
diff --git a/src/buildstream/plugins/elements/cmake.py b/src/buildstream/plugins/elements/cmake.py deleted file mode 100644 index 74da04899..000000000 --- a/src/buildstream/plugins/elements/cmake.py +++ /dev/null @@ -1,74 +0,0 @@ -# -# Copyright (C) 2016, 2018 Codethink Limited -# -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation; either -# version 2 of the License, or (at your option) any later version. -# -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library. If not, see <http://www.gnu.org/licenses/>. -# -# Authors: -# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> - -""" -cmake - CMake build element -=========================== -This is a :mod:`BuildElement <buildstream.buildelement>` implementation for -using the `CMake <https://cmake.org/>`_ build system. - -You will often want to pass additional arguments to the ``cmake`` program for -specific configuration options. This should be done on a per-element basis by -setting the ``cmake-local`` variable. Here is an example: - -.. code:: yaml - - variables: - cmake-local: | - -DCMAKE_BUILD_TYPE=Debug - -If you want to pass extra options to ``cmake`` for every element in your -project, set the ``cmake-global`` variable in your project.conf file. Here is -an example of that: - -.. code:: yaml - - elements: - cmake: - variables: - cmake-global: | - -DCMAKE_BUILD_TYPE=Release - -Here is the default configuration for the ``cmake`` element in full: - - .. literalinclude:: ../../../src/buildstream/plugins/elements/cmake.yaml - :language: yaml - -See :ref:`built-in functionality documentation <core_buildelement_builtins>` for -details on common configuration options for build elements. -""" - -from buildstream import BuildElement, SandboxFlags - - -# Element implementation for the 'cmake' kind. -class CMakeElement(BuildElement): - # Supports virtual directories (required for remote execution) - BST_VIRTUAL_DIRECTORY = True - - # Enable command batching across prepare() and assemble() - def configure_sandbox(self, sandbox): - super().configure_sandbox(sandbox) - self.batch_prepare_assemble(SandboxFlags.ROOT_READ_ONLY, - collect=self.get_variable('install-root')) - - -# Plugin entry point -def setup(): - return CMakeElement |