summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTristan van Berkom <tristan@codethink.co.uk>2020-09-26 17:50:43 +0900
committerbst-marge-bot <marge-bot@buildstream.build>2020-09-28 09:26:09 +0000
commit4831f5bc8f7752447905fa34c241610b1024872c (patch)
treead2274d084e428663d94a51c3bb06b8781ed8b6c /doc
parentd2b0039cbd7ceaac9fd66bb4e17db04f321d494e (diff)
downloadbuildstream-4831f5bc8f7752447905fa34c241610b1024872c.tar.gz
doc: Documenting ability to specify multiple filenames in a dependency.
Diffstat (limited to 'doc')
-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``