diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2019-08-12 15:54:59 -0400 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2019-08-31 15:05:52 +0300 |
| commit | f538fce83a0b902f6097c9a02b273cf2091b106e (patch) | |
| tree | b9865f792804c3be5d08212b541dba07778c0ecc | |
| parent | cc51e4a2d4f338b4dd49337432170b4e30ebe8d0 (diff) | |
| download | buildstream-f538fce83a0b902f6097c9a02b273cf2091b106e.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.rst | 11 | ||||
| -rw-r--r-- | doc/source/using_config.rst | 2 |
2 files changed, 13 insertions, 0 deletions
diff --git a/doc/source/format_declaring.rst b/doc/source/format_declaring.rst index a38973347..80365c6d5 100644 --- a/doc/source/format_declaring.rst +++ b/doc/source/format_declaring.rst @@ -370,6 +370,7 @@ Dependency dictionary: - filename: foo.bst type: build junction: baseproject.bst + strict: false Attributes: @@ -400,6 +401,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 8a6b9ac76..967dde2ed 100644 --- a/doc/source/using_config.rst +++ b/doc/source/using_config.rst @@ -201,6 +201,8 @@ configuration will be used as fallback. instance-name: main +.. _user_config_strict_mode: + Strict build plan ~~~~~~~~~~~~~~~~~ The strict build plan option decides whether you want elements |