summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2019-08-12 15:54:59 -0400
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2019-08-31 15:50:10 +0300
commit1d4561b89e0c22dbb72839d3762974fdf037b27b (patch)
treeb39b669a6e38ab63f0124b480e9503c658c751d3
parent1b663ed9a8e487050926ffdd628366c611d4d838 (diff)
downloadbuildstream-1d4561b89e0c22dbb72839d3762974fdf037b27b.tar.gz
doc/source/format_declaring.rst: Documenting strict dependencies
This adds documentation on the new keyword `strict` in dependency declarations, and adds a link to the strict mode user config section.
-rw-r--r--doc/source/format_declaring.rst11
-rw-r--r--doc/source/using_config.rst2
2 files changed, 13 insertions, 0 deletions
diff --git a/doc/source/format_declaring.rst b/doc/source/format_declaring.rst
index f69d4a479..5c9d64030 100644
--- a/doc/source/format_declaring.rst
+++ b/doc/source/format_declaring.rst
@@ -350,6 +350,7 @@ Dependency dictionary:
- filename: foo.bst
type: build
junction: baseproject.bst
+ strict: false
Attributes:
@@ -380,6 +381,16 @@ Attributes:
The ``junction`` attribute is available since :ref:`format version 1 <project_format_version>`
+* ``strict``
+
+ This attribute can be used to specify that this element should
+ be rebuilt when the dependency changes, even when
+ :ref:`strict mode <user_config_strict_mode>` has been turned off.
+
+ This is appropriate whenever a dependency's output is consumed
+ verbatim in the output of the depending element, for instance
+ when static linking is in use.
+
Cross-junction dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/source/using_config.rst b/doc/source/using_config.rst
index c707cd04b..8b6cb58b0 100644
--- a/doc/source/using_config.rst
+++ b/doc/source/using_config.rst
@@ -65,6 +65,8 @@ by the project.
If you give a list of URLs, earlier entries in the list will have higher
priority than later ones.
+.. _user_config_strict_mode:
+
Strict build plan
~~~~~~~~~~~~~~~~~
The strict build plan option decides whether you want elements