diff options
| author | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2020-08-17 16:18:29 +0000 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2020-08-17 16:18:29 +0000 |
| commit | 4d2735ce50b3cd3d6736ef93736315c292ad3c56 (patch) | |
| tree | 5ceb61e88e7d0e8eadf77af65a78a2e75b99bd0f | |
| parent | 47ec22e656b17ba59432b619befa5fd24bdea7bd (diff) | |
| parent | 024539e406af953fc74f78e8e50d1f2c2b943566 (diff) | |
| download | buildstream-4d2735ce50b3cd3d6736ef93736315c292ad3c56.tar.gz | |
Merge branch 'tristan/docs-fixes' into 'master'
Minor documentation fixes
See merge request BuildStream/buildstream!2034
| -rw-r--r-- | doc/source/format_declaring.rst | 11 | ||||
| -rw-r--r-- | src/buildstream/plugin.py | 2 |
2 files changed, 8 insertions, 5 deletions
diff --git a/doc/source/format_declaring.rst b/doc/source/format_declaring.rst index d8414c2bd..391591530 100644 --- a/doc/source/format_declaring.rst +++ b/doc/source/format_declaring.rst @@ -479,7 +479,7 @@ Dependency types The dependency ``type`` attribute defines what the dependency is required for and is essential to how BuildStream plots a build plan. -There are two types which one can specify for a dependency: +There are three types which one can specify for a dependency: * ``build`` @@ -492,10 +492,13 @@ There are two types which one can specify for a dependency: A ``runtime`` dependency type states that the given element's product must be present for the depending element to function. An element's - ``runtime`` dependencies need not be staged in order to build the element. + ``runtime`` dependencies are not available to the element at build time. -If ``type`` is not specified, then it is assumed that the dependency is -required both at build time and runtime. +* ``all`` + + An ``all`` dependency is the default dependency type. If ``all`` is specified, + or if ``type`` is not specified at all, then it is assumed that the dependency + is required both at build time and runtime. .. note:: diff --git a/src/buildstream/plugin.py b/src/buildstream/plugin.py index 14e22e56d..deb105a3b 100644 --- a/src/buildstream/plugin.py +++ b/src/buildstream/plugin.py @@ -297,7 +297,7 @@ class Plugin: Plugin implementors should implement this method to read configuration data and store it. - The :func:`MappingNode.validate_keys() <buildstream._yaml.MappingNode.validate_keys>` method + The :func:`MappingNode.validate_keys() <buildstream.node.MappingNode.validate_keys>` method should be used to ensure that the user has not specified keys in `node` which are unsupported by the plugin. |