blob: 84a7652911c751843b0fc40e6d247ecb59bca534 (
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
.. _developing_workspaces:
Workspaces
==========
In this section we will cover the use of BuildStream's workspaces feature when devloping on a
BuildStream project.
.. note::
This example is distributed with BuildStream
in the `doc/examples/developing
<https://gitlab.com/BuildStream/buildstream/tree/master/doc/examples/developing>`_
subdirectory.
We will start with the project used in the :ref:`running commands <tutorial_running_commands>`
tutorial. Recall the element hello.bst, which builds the bellow C file:
.. literalinclude:: ../../examples/developing/files/src/hello.c
:language: c
Suppose we now want to alter the functionality of the *hello* command. We can
make changes to the source code of Buildstream elements by making use of
BuildStream's workspace command.
Opening a workspace
-------------------
First we need to open a workspace, we can do this by running
.. raw:: html
:file: ../sessions-stored/developing-workspace-open.html
This command has created the workspace_hello directory in which you can see
the source for the hello.bst element, i.e. hello.c and the corresponding
makefile.
You can view existing workspaces using
.. raw:: html
:file: ../sessions-stored/developing-workspace-list.html
Making code changes
-------------------
Let's say we want to alter the message printed when the hello command is run.
We can open workspace_hello/hello.c and make the following change:
.. literalinclude:: ../../examples/developing/update.patch
:language: diff
Now, rebuild the hello.bst element
.. raw:: html
:file: ../sessions-stored/developing-build-after-changes.html
Now running the hello command using bst shell:
.. raw:: html
:file: ../sessions-stored/developing-shell-after-changes.html
This gives us the new message we changed in hello.c.
From this point we have several options. If the source is under version control
we can commit our changes and push them to the remote repository.
Closing your workspace
----------------------
If we want to close the workspace and come back to our changes later, we can
.. raw:: html
:file: ../sessions-stored/developing-close-workspace.html
We can then reopen the workspace later using:
.. raw:: html
:file: ../sessions-stored/developing-reopen-workspace.html
The --no-checkout option tells BuildStream not to check the source out but to
instead hard-link to the workspace_hello directory.
Alternatively, if we wish to discard the changes we can use
.. raw:: html
:file: ../sessions-stored/developing-reset-workspace.html
This resets the workspace to its original state.
To discard the workspace completely we can do:
.. raw:: html
:file: ../sessions-stored/developing-discard-workspace.html
This will close the workspace and completely remove the workspace_hello
directory.
|
