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

Fixing some fallout in the workspace documentation additions

Closes #553

See merge request !732

.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

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

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