diff options
author | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2018-08-25 11:41:15 +0000 |
---|---|---|
committer | Tristan Van Berkom <tristan.van.berkom@gmail.com> | 2018-08-25 11:41:15 +0000 |
commit | d819fb6477b6c76a2c88cc59aa927fbf6019171e (patch) | |
tree | 16a5f6ad41d6b4ef0f1cb03a894c0875a235e158 /doc | |
parent | f991644cdb1f31763d30516d7b9b96661e6dad6d (diff) | |
parent | 4f8fe9778023748e4354c103c37475f7bcabe51e (diff) | |
download | buildstream-d819fb6477b6c76a2c88cc59aa927fbf6019171e.tar.gz |
Merge branch 'tristan/fixup-workspace-docs' into 'master'
Fixing some fallout in the workspace documentation additions
Closes #553
See merge request BuildStream/buildstream!732
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/developing/workspaces.rst | 6 | ||||
-rw-r--r-- | doc/source/sessions-stored/developing-build-after-changes.html (renamed from doc/source/sessions/developing-build-after-changes.html) | 0 | ||||
-rw-r--r-- | doc/source/sessions-stored/developing-close-workspace.html (renamed from doc/source/sessions/developing-close-workspace.html) | 0 | ||||
-rw-r--r-- | doc/source/sessions-stored/developing-discard-workspace.html (renamed from doc/source/sessions/developing-discard-workspace.html) | 0 | ||||
-rw-r--r-- | doc/source/sessions-stored/developing-reopen-workspace.html (renamed from doc/source/sessions/developing-reopen-workspace.html) | 0 | ||||
-rw-r--r-- | doc/source/sessions-stored/developing-reset-workspace.html (renamed from doc/source/sessions/developing-reset-workspace.html) | 0 | ||||
-rw-r--r-- | doc/source/sessions-stored/developing-shell-after-changes.html (renamed from doc/source/sessions/developing-shell-after-changes.html) | 0 | ||||
-rw-r--r-- | doc/source/sessions-stored/developing-workspace-list.html (renamed from doc/source/sessions/developing-workspace-list.html) | 0 | ||||
-rw-r--r-- | doc/source/sessions-stored/developing-workspace-open.html (renamed from doc/source/sessions/developing-workspace-open.html) | 0 |
9 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/developing/workspaces.rst b/doc/source/developing/workspaces.rst index a545bb661..b5ed64b2c 100644 --- a/doc/source/developing/workspaces.rst +++ b/doc/source/developing/workspaces.rst @@ -4,9 +4,9 @@ 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 @@ -25,7 +25,6 @@ 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 @@ -37,12 +36,12 @@ 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/developing-workspace-list.html + Making code changes ------------------- 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. 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 diff --git a/doc/source/sessions/developing-build-after-changes.html b/doc/source/sessions-stored/developing-build-after-changes.html index 4699c0dc5..4699c0dc5 100644 --- a/doc/source/sessions/developing-build-after-changes.html +++ b/doc/source/sessions-stored/developing-build-after-changes.html diff --git a/doc/source/sessions/developing-close-workspace.html b/doc/source/sessions-stored/developing-close-workspace.html index 498896d4d..498896d4d 100644 --- a/doc/source/sessions/developing-close-workspace.html +++ b/doc/source/sessions-stored/developing-close-workspace.html diff --git a/doc/source/sessions/developing-discard-workspace.html b/doc/source/sessions-stored/developing-discard-workspace.html index b838c8281..b838c8281 100644 --- a/doc/source/sessions/developing-discard-workspace.html +++ b/doc/source/sessions-stored/developing-discard-workspace.html diff --git a/doc/source/sessions/developing-reopen-workspace.html b/doc/source/sessions-stored/developing-reopen-workspace.html index b68ff0c8d..b68ff0c8d 100644 --- a/doc/source/sessions/developing-reopen-workspace.html +++ b/doc/source/sessions-stored/developing-reopen-workspace.html diff --git a/doc/source/sessions/developing-reset-workspace.html b/doc/source/sessions-stored/developing-reset-workspace.html index 73291b5dd..73291b5dd 100644 --- a/doc/source/sessions/developing-reset-workspace.html +++ b/doc/source/sessions-stored/developing-reset-workspace.html diff --git a/doc/source/sessions/developing-shell-after-changes.html b/doc/source/sessions-stored/developing-shell-after-changes.html index 6ad3549ac..6ad3549ac 100644 --- a/doc/source/sessions/developing-shell-after-changes.html +++ b/doc/source/sessions-stored/developing-shell-after-changes.html diff --git a/doc/source/sessions/developing-workspace-list.html b/doc/source/sessions-stored/developing-workspace-list.html index 184d82e01..184d82e01 100644 --- a/doc/source/sessions/developing-workspace-list.html +++ b/doc/source/sessions-stored/developing-workspace-list.html diff --git a/doc/source/sessions/developing-workspace-open.html b/doc/source/sessions-stored/developing-workspace-open.html index 0ca59945c..0ca59945c 100644 --- a/doc/source/sessions/developing-workspace-open.html +++ b/doc/source/sessions-stored/developing-workspace-open.html |