diff options
Diffstat (limited to 'src/buildstream/buildelement.py')
| -rw-r--r-- | src/buildstream/buildelement.py | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/src/buildstream/buildelement.py b/src/buildstream/buildelement.py index 95b085eba..32b64a8ed 100644 --- a/src/buildstream/buildelement.py +++ b/src/buildstream/buildelement.py @@ -23,11 +23,11 @@ BuildElement - Abstract class for build elements The BuildElement class is a convenience element one can derive from for implementing the most common case of element. + .. _core_buildelement_builtins: Built-in functionality ---------------------- - The BuildElement base class provides built in functionality that could be overridden by the individual plugins. @@ -35,6 +35,7 @@ This section will give a brief summary of how some of the common features work, some of them or the variables they use will be further detailed in the following sections. + The `strip-binaries` variable ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The `strip-binaries` variable is by default **empty**. You need to use the @@ -43,12 +44,14 @@ If you are targetting Linux, ones known to work are the ones used by the `freedesktop-sdk <https://freedesktop-sdk.io/>`_, you can take a look to them in their `project.conf <https://gitlab.com/freedesktop-sdk/freedesktop-sdk/blob/freedesktop-sdk-18.08.21/project.conf#L74>`_ + Location for running commands ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``command-subdir`` variable sets where the build commands will be executed, if the directory does not exist it will be created, it is defined relative to the buildroot. + Location for configuring the project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``conf-root`` is defined by default as ``.`` and is the location that @@ -66,21 +69,19 @@ The current working directory when your configuration command is run will still be wherever you set your ``command-subdir`` to be, regardless of where the configure scripts are set with ``conf-root``. -.. note:: - - The ``conf-root`` variable is available since :ref:`format version 17 <project_format_version>` Install Location ~~~~~~~~~~~~~~~~ - You should not change the ``install-root`` variable as it is a special writeable location in the sandbox but it is useful when writing custom install instructions as it may need to be supplied as the ``DESTDIR``, please see the :mod:`cmake <elements.cmake>` build element for example. + Abstract method implementations ------------------------------- + Element.configure_sandbox() ~~~~~~~~~~~~~~~~~~~~~~~~~~~ In :func:`Element.configure_sandbox() <buildstream.element.Element.configure_sandbox>`, |