Merge branch 'tristan/fixup-workspace-docs' into 'master'

Fixing some fallout in the workspace documentation additions

Closes #553

See merge request BuildStream/buildstream!732

11 files changed, 8 insertions, 4 deletions

diff --git a/.gitignore b/.gitignore
index 90a50449f..04f9e1690 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,7 +25,8 @@ __pycache__/
 # Generated version file
 buildstream/__version__.py
 
-#Autogenerated doc
+# Autogenerated doc
+doc/source/sessions/
 doc/source/elements/
 doc/source/sources/
 doc/source/modules.rst
diff --git a/HACKING.rst b/HACKING.rst
index 74256c7b3..1c5832597 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -390,6 +390,9 @@ Each *command* is a dictionary, the members of which are listed here:
 
 * ``command``: The command to run, without the leading ``bst``
 
+* ``shell``: Specifying ``True`` indicates that ``command`` should be run as
+  a shell command from the project directory, instead of a bst command (optional)
+
 When adding a new ``.run`` file, one should normally also commit the new
 resulting generated ``.html`` file(s) into the ``doc/source/sessions-stored/``
 directory at the same time, this ensures that other developers do not need to
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