summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Maw <jonathan.maw@codethink.co.uk>2017-12-14 15:10:47 +0000
committerJonathan Maw <jonathan.maw@codethink.co.uk>2017-12-14 15:10:47 +0000
commit993acc96c21e32063fc2cb5e75b8a9f5c8d4ca5e (patch)
tree15a91757bd9abf95d7f09465e00615c74bbac98f
parent5898b9168f212c6f492ad0ffbc51617b51c38c11 (diff)
downloadbuildstream-jonathan/fix-plugin-loading.tar.gz
project: Rename required-project-version to format-versionjonathan/fix-plugin-loading
-rw-r--r--buildstream/_project.py4
-rw-r--r--doc/source/projectconf.rst4
-rw-r--r--tests/project/data/unsupported/project.conf2
3 files changed, 5 insertions, 5 deletions
diff --git a/buildstream/_project.py b/buildstream/_project.py
index d340fb989..e48690bff 100644
--- a/buildstream/_project.py
+++ b/buildstream/_project.py
@@ -128,7 +128,7 @@ class Project():
config.pop('elements', None)
_yaml.node_final_assertions(config)
_yaml.node_validate(config, [
- 'required-project-version',
+ 'format-version',
'element-path', 'variables',
'environment', 'environment-nocache',
'split-rules', 'elements', 'plugins',
@@ -179,7 +179,7 @@ class Project():
self._workspaces = self._load_workspace_config()
# Assert project version
- format_version = _yaml.node_get(config, int, 'required-project-version', default_value=0)
+ format_version = _yaml.node_get(config, int, 'format-version', default_value=0)
if BST_FORMAT_VERSION < format_version:
major, minor = utils.get_bst_version()
raise LoadError(
diff --git a/doc/source/projectconf.rst b/doc/source/projectconf.rst
index 565de3601..e1649de54 100644
--- a/doc/source/projectconf.rst
+++ b/doc/source/projectconf.rst
@@ -147,12 +147,12 @@ Project Version Format
''''''''''''''''''''''
The project's minimum required version of buildstream is specified in
-``project.conf`` with the ``required-project-version`` field, e.g.
+``project.conf`` with the ``format-version`` field, e.g.
.. code:: yaml
# The minimum base BuildStream format
- required-project-version: 0
+ format-version: 0
.. _project_options:
diff --git a/tests/project/data/unsupported/project.conf b/tests/project/data/unsupported/project.conf
index de94ba3be..ecd8e06cc 100644
--- a/tests/project/data/unsupported/project.conf
+++ b/tests/project/data/unsupported/project.conf
@@ -1,3 +1,3 @@
# A project which requires a too new version of the format
name: foo
-required-project-version: 5000
+format-version: 5000