diff options
| author | Jonathan Maw <jonathan.maw@codethink.co.uk> | 2017-12-14 15:10:47 +0000 |
|---|---|---|
| committer | Jonathan Maw <jonathan.maw@codethink.co.uk> | 2017-12-14 16:17:12 +0000 |
| commit | 461ab56a19e86faf482bef2b7cbea1017d16d8d7 (patch) | |
| tree | c0ba869408eccc1303dea69f83a6f8ebacbee2cd | |
| parent | 4915adea8ca792b4c3b4b49d040f7ecd0d697700 (diff) | |
| download | buildstream-461ab56a19e86faf482bef2b7cbea1017d16d8d7.tar.gz | |
project: Rename required-project-version to format-version
| -rw-r--r-- | buildstream/_project.py | 4 | ||||
| -rw-r--r-- | doc/source/projectconf.rst | 4 | ||||
| -rw-r--r-- | tests/project/data/unsupported/project.conf | 2 |
3 files changed, 5 insertions, 5 deletions
diff --git a/buildstream/_project.py b/buildstream/_project.py index 286079057..279966da9 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 |