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).

7 files changed, 12 insertions, 48 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>`,
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