summaryrefslogtreecommitdiff
path: root/doc
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-25 00:16:01 +0900
commite5e776c4f0017632c6c7497ca9410aa66370278b (patch)
tree75716e40cd338551ee79867716cc3a51a04e44ee /doc
parent6ef6be52c1cd66245fc7f13a3c472024e10c3c1a (diff)
downloadbuildstream-e5e776c4f0017632c6c7497ca9410aa66370278b.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).
Diffstat (limited to 'doc')
-rw-r--r--doc/source/format_declaring.rst20
-rw-r--r--doc/source/format_intro.rst4
-rw-r--r--doc/source/format_project.rst36
3 files changed, 0 insertions, 60 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: