summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTristan van Berkom <tristan.vanberkom@codethink.co.uk>2020-08-15 19:41:57 +0900
committerTristan van Berkom <tristan.vanberkom@codethink.co.uk>2020-08-17 19:58:18 +0900
commitc85370b4726caee6a584b2cc95a7f22daabcc6bb (patch)
treea1dae20c37c34dec05d888dcde3b20eca870cabf /doc
parent47ec22e656b17ba59432b619befa5fd24bdea7bd (diff)
downloadbuildstream-c85370b4726caee6a584b2cc95a7f22daabcc6bb.tar.gz
doc/source/format_declaring.rst: Documenting the ``all`` dependency type
The loader has supported dependencies explicitly being ``all`` for the dependency type (instead of only "build", "runtime" and unspecified) for a long time, but this was not properly documented.
Diffstat (limited to 'doc')
-rw-r--r--doc/source/format_declaring.rst11
1 files changed, 7 insertions, 4 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::