summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2020-04-23 20:37:57 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2020-04-24 18:31:29 +0900
commited2b5e669f4a5365d948a2ff08a2da49660c0d37 (patch)
tree58b9f5ad0f9fcc7e96d54f199a1aaf0350abca26
parent508ff9ab0aa8b38277f8e10f8f3120098d504771 (diff)
downloadbuildstream-ed2b5e669f4a5365d948a2ff08a2da49660c0d37.tar.gz
Remove documentation references to format_version
With BuildStream 2.0, we start with a fresh API, everything that is present at the time of the 2.0 release can implicitly be considered to be available since 2.0. In the future, we will be expressing new API additions using the min-version semantic versioning style instead of format version too (so new YAML configurations will be expressed as "since: 2.2" and so on).
-rw-r--r--doc/source/format_declaring.rst20
-rw-r--r--doc/source/format_intro.rst4
-rw-r--r--doc/source/format_project.rst36
-rw-r--r--src/buildstream/buildelement.py11
-rw-r--r--src/buildstream/plugin.py4
-rw-r--r--src/buildstream/plugins/elements/filter.py21
-rw-r--r--src/buildstream/plugins/elements/junction.py8
-rw-r--r--src/buildstream/plugins/sources/git.py8
-rw-r--r--src/buildstream/plugins/sources/pip.py4
-rw-r--r--src/buildstream/plugins/sources/remote.py4
10 files changed, 12 insertions, 108 deletions
diff --git a/doc/source/format_declaring.rst b/doc/source/format_declaring.rst
index 80365c6d5..6805c249b 100644
--- a/doc/source/format_declaring.rst
+++ b/doc/source/format_declaring.rst
@@ -124,10 +124,6 @@ The above code snippet is equivalent to:
See :ref:`format_dependencies` for more information on the dependency model.
-.. note::
-
- The ``build-depends`` configuration is available since :ref:`format version 14 <project_format_version>`
-
.. _format_runtime_depends:
@@ -155,10 +151,6 @@ The above code snippet is equivalent to:
See :ref:`format_dependencies` for more information on the dependency model.
-.. note::
-
- The ``runtime-depends`` configuration is available since :ref:`format version 14 <project_format_version>`
-
.. _format_sources:
@@ -331,10 +323,6 @@ field in the ``Command`` uploaded. Whether this actually results in a building
the element for the desired OS and architecture is dependent on the server
having implemented these options the same as buildstream.
-.. note::
-
- The ``sandbox`` configuration is available since :ref:`format version 6 <project_format_version>`
-
.. _format_dependencies:
@@ -397,10 +385,6 @@ Attributes:
See :mod:`junction <elements.junction>`.
- .. note::
-
- The ``junction`` attribute is available since :ref:`format version 1 <project_format_version>`
-
* ``strict``
This attribute can be used to specify that this element should
@@ -442,10 +426,6 @@ attribute, like so:
raised. See :ref:`nested junctions <core_junction_nested>` for more details
on nested junctions.
-.. note::
-
- This shorthand is available since :ref:`format version 23 <project_format_version>`
-
.. _format_dependencies_types:
diff --git a/doc/source/format_intro.rst b/doc/source/format_intro.rst
index e8fe6007b..cc743451b 100644
--- a/doc/source/format_intro.rst
+++ b/doc/source/format_intro.rst
@@ -343,7 +343,3 @@ the previous one.
must be declared in the :ref:`project.conf <projectconf>` or in
included files which are local to the project declaring the
junction itself.
-
-.. note::
-
- The include directive is available since :ref:`format version 12 <project_format_version>`
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst
index 3ee91e0f9..8cf2c0026 100644
--- a/doc/source/format_project.rst
+++ b/doc/source/format_project.rst
@@ -120,10 +120,6 @@ following to your ``project.conf``:
ref-storage: project.refs
-.. note::
-
- The ``ref-storage`` configuration is available since :ref:`format version 8 <project_format_version>`
-
.. _configurable_warnings:
@@ -145,10 +141,6 @@ Individual warnings can be configured as fatal by setting ``fatal-warnings`` to
BuildStream provides a collection of :class:`Core Warnings <buildstream.types.CoreWarnings>` which may be raised
by a variety of plugins. Other configurable warnings are plugin specific and should be noted within their individual documentation.
-.. note::
-
- The ``fatal-warnings`` configuration is available since :ref:`format version 14 <project_format_version>`
-
.. _project_source_aliases:
@@ -179,10 +171,6 @@ for more detail.
build-uid: 1003
build-gid: 1001
-.. note::
-
- The ``sandbox`` configuration is available since :ref:`format version 6 <project_format_version>`
-
.. _project_essentials_artifacts:
@@ -373,10 +361,6 @@ A default mirror to consult first can be defined via
:ref:`user config <config_default_mirror>`, or the command-line argument
:ref:`--default-mirror <invoking_bst>`.
-.. note::
-
- The ``mirrors`` field is available since :ref:`format version 11 <project_format_version>`
-
.. _project_plugins:
@@ -852,10 +836,6 @@ specific configuration data as shown below.
config:
checkout-submodules: False
-.. note::
-
- The ``sources`` override is available since :ref:`format version 1 <project_format_version>`
-
.. _project_shell:
@@ -867,10 +847,6 @@ environment for debugging and testing applications may need some help.
The ``shell`` section allows some customization of the shell environment.
-.. note::
-
- The ``shell`` section is available since :ref:`format version 1 <project_format_version>`
-
Interactive shell command
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -903,10 +879,6 @@ which is expressed as a dictionary very similar to the
:ref:`default environment <project_defaults_environment>`, except that it
supports host side environment variable expansion in values.
-.. note::
-
- The ``environment`` configuration is available since :ref:`format version 4 <project_format_version>`
-
For example, to share your host ``DISPLAY`` and ``DBUS_SESSION_BUS_ADDRESS``
environments with debugging shells for your project, specify the following:
@@ -939,10 +911,6 @@ it can integrate better with the host environment.
The ``host-files`` configuration allows one to specify files and
directories on the host to be bind mounted into the sandbox.
-.. note::
-
- The ``host-files`` configuration is available since :ref:`format version 4 <project_format_version>`
-
.. warning::
One should never mount directories where one expects to
@@ -1052,10 +1020,6 @@ currently limited to a single target element and due to this, they currently
do not use project default targets. However, they still use the workspace
element as default target when run from a workspace directory.
-.. note::
-
- The ``targets`` configuration is available since :ref:`format version 21 <project_format_version>`
-
.. _project_builtin_defaults:
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>`,
diff --git a/src/buildstream/plugin.py b/src/buildstream/plugin.py
index 5c362aff6..2182f5a08 100644
--- a/src/buildstream/plugin.py
+++ b/src/buildstream/plugin.py
@@ -167,10 +167,6 @@ class Plugin:
Plugins are expected to maintain backward compatibility
in the format and configurations they expose. The versioning
is intended to track availability of new features only.
-
- For convenience, the format version for plugins maintained and
- distributed with BuildStream are revisioned with BuildStream's
- core format version :ref:`core format version <project_format_version>`.
"""
BST_PLUGIN_DEPRECATED = False
diff --git a/src/buildstream/plugins/elements/filter.py b/src/buildstream/plugins/elements/filter.py
index 71ed1f6cb..d5749ad2d 100644
--- a/src/buildstream/plugins/elements/filter.py
+++ b/src/buildstream/plugins/elements/filter.py
@@ -77,21 +77,14 @@ we can define the following filter, ``filter-foo.bst``:
kind: filter
# Declare the sole build-dependency of the filter element
- depends:
- - filename: import.bst
- type: build
+ build-depends:
+ - import.bst
# Declare a list of domains to include in the filter's artifact
config:
include:
- foo
-.. note::
-
- We can also specify build-dependencies with a 'build-depends' field which has been
- available since :ref:`format version 14 <project_format_version>`. See the
- :ref:`Build-Depends documentation <format_build_depends>` for more detail.
-
It should be noted that an 'empty' ``include:`` list would, by default, include all
split-rules specified in the parent element, which, in this example, would be the
files 'foo' and 'bar' (the file 'baz' was not covered by any split rules).
@@ -104,9 +97,8 @@ only contains the file 'foo') by declaring the following element, ``exclude-bar.
kind: filter
# Declare the sole build-dependency of the filter element
- depends:
- - filename: import.bst
- type: build
+ build-depends:
+ - import.bst
# Declare a list of domains to exclude in the filter's artifact
config:
@@ -123,9 +115,8 @@ which are not included as split rules we can define the following element, ``fil
kind: filter
# Declare the sole build-dependency of the filter element
- depends:
- - filename: import.bst
- type: build
+ build-depends:
+ - import.bst
# Filter out all files which are not declared as split rules
config:
diff --git a/src/buildstream/plugins/elements/junction.py b/src/buildstream/plugins/elements/junction.py
index f0fcdcdfd..46c4ddf68 100644
--- a/src/buildstream/plugins/elements/junction.py
+++ b/src/buildstream/plugins/elements/junction.py
@@ -66,14 +66,6 @@ Overview
.. note::
- The configuration option to allow specifying junction targets is available
- since :ref:`format version 24 <project_format_version>` and the configuration
- options allowing for junction project elements to interact with parent remotes
- or to completely ignore junction project remotes are available since
- :ref:`format version 25 <project_format_version>`.
-
-.. note::
-
Junction elements may not specify any dependencies as they are simply
links to other projects and are not in the dependency graph on their own.
diff --git a/src/buildstream/plugins/sources/git.py b/src/buildstream/plugins/sources/git.py
index d04ccfe1b..473166132 100644
--- a/src/buildstream/plugins/sources/git.py
+++ b/src/buildstream/plugins/sources/git.py
@@ -143,17 +143,9 @@ This plugin provides the following :ref:`configurable warnings <configurable_war
- ``git:unlisted-submodule`` - A submodule is present in the git repository but was not specified in
the source configuration and was not disabled for checkout.
- .. note::
-
- The ``git:unlisted-submodule`` warning is available since :ref:`format version 20 <project_format_version>`
-
- ``git:invalid-submodule`` - A submodule is specified in the source configuration but does not exist
in the repository.
- .. note::
-
- The ``git:invalid-submodule`` warning is available since :ref:`format version 20 <project_format_version>`
-
This plugin also utilises the following configurable :class:`core warnings <buildstream.types.CoreWarnings>`:
- :attr:`ref-not-in-track <buildstream.types.CoreWarnings.REF_NOT_IN_TRACK>` - The provided ref was not
diff --git a/src/buildstream/plugins/sources/pip.py b/src/buildstream/plugins/sources/pip.py
index c3af0f9cf..69c08e81f 100644
--- a/src/buildstream/plugins/sources/pip.py
+++ b/src/buildstream/plugins/sources/pip.py
@@ -62,10 +62,6 @@ Downloaded tarballs will be stored in a directory called ".bst_pip_downloads".
See :ref:`built-in functionality doumentation <core_source_builtins>` for
details on common configuration options for sources.
-
-.. note::
-
- The ``pip`` plugin is available since :ref:`format version 16 <project_format_version>`
"""
import hashlib
diff --git a/src/buildstream/plugins/sources/remote.py b/src/buildstream/plugins/sources/remote.py
index da1a1f964..29333c0d9 100644
--- a/src/buildstream/plugins/sources/remote.py
+++ b/src/buildstream/plugins/sources/remote.py
@@ -46,10 +46,6 @@ remote - stage files from remote urls
See :ref:`built-in functionality doumentation <core_source_builtins>` for
details on common configuration options for sources.
-
-.. note::
-
- The ``remote`` plugin is available since :ref:`format version 10 <project_format_version>`
"""
import os
from buildstream import SourceError, utils