summaryrefslogtreecommitdiff
path: root/doc/sessions/junctions.run
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2020-04-11 16:45:14 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2020-04-17 20:58:24 +0900
commit35cca7458837aab1ca697beaa865f99f7466ca1c (patch)
tree4e79676c31db9c3011c1e1579899e96fce99fab2 /doc/sessions/junctions.run
parentc3e4978024900053f24da89f208f909d4acbc963 (diff)
downloadbuildstream-35cca7458837aab1ca697beaa865f99f7466ca1c.tar.gz
doc: Refactoring junction documentation
Renamed the "Advanced topics" section to "Combining projects", and splitting up the junctions section into two separate documents, one which describes the simplest junction example and another which explains how to use workspaces in conjunction with junctions. This commit also makes some minor changes the examples, correcting some grammatical errors, improving links and formatting, also rewording a `note::` in order to clarify that it would be unusual to junction a project that is in a subdirectory.
Diffstat (limited to 'doc/sessions/junctions.run')
-rw-r--r--doc/sessions/junctions.run10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/sessions/junctions.run b/doc/sessions/junctions.run
index fc9014203..b03b06a15 100644
--- a/doc/sessions/junctions.run
+++ b/doc/sessions/junctions.run
@@ -10,11 +10,19 @@ commands:
output: ../source/sessions/junctions-shell.html
command: shell callHello.bst -- /bin/sh callHello.sh
+# Open a workspace on the junction:
+- directory: ../examples/junctions
+ output: ../source/sessions/junctions-workspace-open-subproject.html
+ command: workspace open --directory workspace_subproject hello-junction.bst
+
# Open a crossJunction workspace:
- directory: ../examples/junctions
output: ../source/sessions/junctions-workspace-open.html
command: workspace open --directory workspace_hello hello-junction.bst:hello.bst
-# Remove the workspace
+# Remove the workspaces
+- directory: ../examples/junctions
+ command: workspace close --remove-dir hello-junction.bst
+
- directory: ../examples/junctions
command: workspace close --remove-dir hello-junction.bst:hello.bst