blob: 929ac12170d16ccdfb54dc1743939bccaa18cdf8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
Junction elements
=================
BuildStream's junction elements are used to import other BuildStream
projects. This allows you to depend on elements that are part of an
upstream project.
A simple example
----------------
.. note::
This example is distributed with BuildStream in the
`doc/examples/junctions <https://gitlab.com/BuildStream/buildstream/tree/master/doc/examples/junctions>`_
subdirectory.
Below is a simple example of bst file for a junction element:
.. literalinclude:: ../../examples/junctions/elements/hello-junction.bst
:language: yaml
This element imports the autotools example project found in the BuildStream
doc/examples/autotools subdirectory.
.. note::
While for this example we're using a local source, another common use-case,
for junction elements is including a remote, version contolled project,
having a source type such as `-kind: git`.
The below bst file describes an element which depends on the hello.bst element
from the autotools example:
.. literalinclude:: ../../examples/junctions/elements/callHello.bst
:language: yaml
This element consists of a script which calls hello.bst's hello command.
Building callHello.bst,
.. raw:: html
:file: ../sessions-stored/junctions-build.html
You can see that the hello.bst element and it's dependencies from the autotools
project have been build as part of the pipeline for callHello.bst.
We can now invoke `bst shell`
.. raw:: html
:file: ../sessions-stored/junctions-shell.html
This runs the script files/callHello.sh which will makes use of the hello command from the hello.bst element in the autotools project.
Cross-junction workspaces
-------------------------
You can open workspaces for elements in the project refered to by the junction
using the syntax `bst open ${junction-name}:{element-name}`. In this example,
.. raw:: html
:file: ../sessions-stored/junctions-workspace-open.html
This has opened a workspace for the hello.bst element from the autotools project.
This workspace can now be used as normal.
Further reading
---------------
For an example of junction elements being used in a real project, take a look
at the `freedesktop-sdk junction
<https://gitlab.gnome.org/GNOME/gnome-build-meta/blob/master/elements/freedesktop-sdk.bst>`_
in the `gnome-build-meta <https://gitlab.gnome.org/GNOME/gnome-build-meta>`_ project.
|
