Tristan Van Berkom pushed to branch master at BuildStream / buildstream
Commits:
-
f4c2bf19
by Phil Dawson at 2018-08-25T08:43:09Z
-
23b01f24
by Phil Dawson at 2018-08-25T08:43:09Z
-
369bec0c
by Tristan Van Berkom at 2018-08-25T08:44:26Z
-
24cb3037
by Tristan Van Berkom at 2018-08-25T09:10:53Z
-
4f8fe977
by Tristan Van Berkom at 2018-08-25T09:10:53Z
-
d819fb64
by Tristan Van Berkom at 2018-08-25T11:41:15Z
11 changed files:
- .gitignore
- HACKING.rst
- doc/source/developing/workspaces.rst
- doc/source/sessions/developing-build-after-changes.html → doc/source/sessions-stored/developing-build-after-changes.html
- doc/source/sessions/developing-close-workspace.html → doc/source/sessions-stored/developing-close-workspace.html
- doc/source/sessions/developing-discard-workspace.html → doc/source/sessions-stored/developing-discard-workspace.html
- doc/source/sessions/developing-reopen-workspace.html → doc/source/sessions-stored/developing-reopen-workspace.html
- doc/source/sessions/developing-reset-workspace.html → doc/source/sessions-stored/developing-reset-workspace.html
- doc/source/sessions/developing-shell-after-changes.html → doc/source/sessions-stored/developing-shell-after-changes.html
- doc/source/sessions/developing-workspace-list.html → doc/source/sessions-stored/developing-workspace-list.html
- doc/source/sessions/developing-workspace-open.html → doc/source/sessions-stored/developing-workspace-open.html
Changes:
| ... | ... | @@ -25,7 +25,8 @@ __pycache__/ |
| 25 | 25 |
# Generated version file
|
| 26 | 26 |
buildstream/__version__.py
|
| 27 | 27 |
|
| 28 |
-#Autogenerated doc
|
|
| 28 |
+# Autogenerated doc
|
|
| 29 |
+doc/source/sessions/
|
|
| 29 | 30 |
doc/source/elements/
|
| 30 | 31 |
doc/source/sources/
|
| 31 | 32 |
doc/source/modules.rst
|
| ... | ... | @@ -390,6 +390,9 @@ Each *command* is a dictionary, the members of which are listed here: |
| 390 | 390 |
|
| 391 | 391 |
* ``command``: The command to run, without the leading ``bst``
|
| 392 | 392 |
|
| 393 |
+* ``shell``: Specifying ``True`` indicates that ``command`` should be run as
|
|
| 394 |
+ a shell command from the project directory, instead of a bst command (optional)
|
|
| 395 |
+ |
|
| 393 | 396 |
When adding a new ``.run`` file, one should normally also commit the new
|
| 394 | 397 |
resulting generated ``.html`` file(s) into the ``doc/source/sessions-stored/``
|
| 395 | 398 |
directory at the same time, this ensures that other developers do not need to
|
| ... | ... | @@ -4,9 +4,9 @@ |
| 4 | 4 |
|
| 5 | 5 |
Workspaces
|
| 6 | 6 |
==========
|
| 7 |
- |
|
| 8 | 7 |
In this section we will cover the use of BuildStream's workspaces feature when devloping on a
|
| 9 | 8 |
BuildStream project.
|
| 9 |
+ |
|
| 10 | 10 |
.. note::
|
| 11 | 11 |
|
| 12 | 12 |
This example is distributed with BuildStream
|
| ... | ... | @@ -25,7 +25,6 @@ make changes to the source code of Buildstream elements by making use of |
| 25 | 25 |
BuildStream's workspace command.
|
| 26 | 26 |
|
| 27 | 27 |
|
| 28 |
- |
|
| 29 | 28 |
Opening a workspace
|
| 30 | 29 |
-------------------
|
| 31 | 30 |
First we need to open a workspace, we can do this by running
|
| ... | ... | @@ -37,12 +36,12 @@ This command has created the workspace_hello directory in which you can see |
| 37 | 36 |
the source for the hello.bst element, i.e. hello.c and the corresponding
|
| 38 | 37 |
makefile.
|
| 39 | 38 |
|
| 40 |
- |
|
| 41 | 39 |
You can view existing workspaces using
|
| 42 | 40 |
|
| 43 | 41 |
.. raw:: html
|
| 44 | 42 |
:file: ../sessions/developing-workspace-list.html
|
| 45 | 43 |
|
| 44 |
+ |
|
| 46 | 45 |
Making code changes
|
| 47 | 46 |
-------------------
|
| 48 | 47 |
Let's say we want to alter the message printed when the hello command is run.
|
| ... | ... | @@ -66,6 +65,7 @@ This gives us the new message we changed in hello.c. |
| 66 | 65 |
From this point we have several options. If the source is under version control
|
| 67 | 66 |
we can commit our changes and push them to the remote repository.
|
| 68 | 67 |
|
| 68 |
+ |
|
| 69 | 69 |
Closing your workspace
|
| 70 | 70 |
----------------------
|
| 71 | 71 |
If we want to close the workspace and come back to our changes later, we can
|