diff options
| author | James Ennis <james.ennis@codethink.com> | 2018-05-21 17:27:48 +0100 |
|---|---|---|
| committer | James Ennis <james.ennis@codethink.com> | 2018-05-23 12:50:00 +0100 |
| commit | 9ea76a24f5355af03d91e395c66992d16f469cfd (patch) | |
| tree | 873ac01a360ed8545e0e94c75b141445e6442c1f | |
| parent | 206a7ee8085110ac55d7b51c5546154426e2a4fb (diff) | |
| download | buildstream-jennis/note_explicit_tracking_of_junctions.tar.gz | |
junction.py: Include note regarding explicit trackingjennis/note_explicit_tracking_of_junctions
| -rw-r--r-- | buildstream/plugins/elements/junction.py | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/buildstream/plugins/elements/junction.py b/buildstream/plugins/elements/junction.py index df7faf3c5..97c00a090 100644 --- a/buildstream/plugins/elements/junction.py +++ b/buildstream/plugins/elements/junction.py @@ -70,6 +70,22 @@ However, junction elements do not produce any artifacts, which means that they cannot be built or staged. It also means that another element cannot depend on a junction element itself. +.. note:: + + BuildStream does not implicitly track junction elements. This means + that if we were to invoke: `bst build --track-all ELEMENT` on an element + which depends on a junction element, the ref of the junction element + will not automatically be updated if a more recent version exists. + + Therefore, if you require the most up-to-date version of a subproject, + you must explicitly track the junction element by invoking: + `bst track JUNCTION_ELEMENT`. + + Furthermore, elements within the subproject are also not tracked by default. + For this, we must specify the `--track-cross-junctions` option. This option + must be preceeded by `--track ELEMENT` or `--track-all`. + + Sources ------- ``bst show`` does not implicitly fetch junction sources if they haven't been |