Skip to content

Commit cd90dae

Browse files
committed
docs/overlaps: Add 'Changing the location' section
- This adds a section about configuring some Element kinds for staging their dependencies in certain locations.
1 parent 578534c commit cd90dae

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/source/handling-files/overlaps.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,29 @@ command contain an ``rm`` statement, as such:
144144
This would cause later builds of ``runtime-only.bst`` to no longer
145145
conflict on the given file.
146146

147+
Changing the location
148+
---------------------
149+
150+
Some element kinds allow you to stage their dependencies in certain locations.
151+
This would allow for both versions to exist, separated in different
152+
directories. An important thing to note here is that this does also change the
153+
location of the runtime dependencies of an element. This means that it is
154+
important to check that the element in question can cope with this movement of
155+
its dependencies. Expanding off of this, if two dependencies have the same
156+
runtime dependency and then one is moved, there will now be two copies of that
157+
runtime dependency, one in the original location and one in the moved location.
158+
159+
An example of changing the location of a dependency:
160+
161+
.. code:: yaml
162+
163+
filename: components/example.bst
164+
config:
165+
location: "/test"
166+
167+
The BuildStream documentation for changing the staging location can be found
168+
`here
169+
<https://docs.buildstream.build/master/buildstream.buildelement.html#location-for-staging-dependencies>`__
147170

148171
Summary
149172
-------

0 commit comments

Comments
 (0)