summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan van Berkom <tristan@codethink.co.uk>2020-09-26 17:50:43 +0900
committerTristan van Berkom <tristan@codethink.co.uk>2020-09-26 17:50:43 +0900
commit1c0596239a7e8f1757fc47b2596205a2079e4a34 (patch)
treeb1562b859dbec797932975136826298bc7295849
parent5bfa6bf908bbf5da4a135de66b5c3daa54b428c1 (diff)
downloadbuildstream-tristan/dependency-multi-filename.tar.gz
doc: Documenting ability to specify multiple filenames in a dependency.tristan/dependency-multi-filename
-rw-r--r--doc/source/format_declaring.rst18
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/source/format_declaring.rst b/doc/source/format_declaring.rst
index 98b5f926e..380f367e0 100644
--- a/doc/source/format_declaring.rst
+++ b/doc/source/format_declaring.rst
@@ -417,7 +417,23 @@ Attributes:
* ``filename``
- The :ref:`element name <format_element_names>` to depend on.
+ The :ref:`element name <format_element_names>` to depend on, or a list of mutiple element names.
+
+ Specifying multiple element names in a single dependency will result in multiple dependencies
+ being declared with common properties.
+
+ For example, one can declare multiple build dependencies with the same junction:
+
+ .. code:: yaml
+
+ # Declare three build dependencies from subproject.bst
+ depends:
+ - type: build
+ junction: subproject.bst
+ filename:
+ - element-a.bst
+ - element-b.bst
+ - element-c.bst
* ``junction``