summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Ennis <james.ennis@codethink.com>2018-05-03 11:02:19 +0100
committerJames Ennis <james.ennis@codethink.com>2018-05-03 11:09:10 +0100
commitfed0b3f4d306122934f6173f926b184f8150d4f8 (patch)
tree605f4682b6ef56fc1d7f14e2cdfb86d543185b4c
parentf00a435ce51e9fe929615a34be82bbd77d8f1c12 (diff)
downloadbuildstream-jennis/explanation-of-commands.tar.gz
commands.rst: Split up commands to easily allow for further descriptionjennis/explanation-of-commands
An introduction for this section was also added
-rw-r--r--doc/source/commands.rst120
1 files changed, 119 insertions, 1 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst
index dad9fae46..18affc6e5 100644
--- a/doc/source/commands.rst
+++ b/doc/source/commands.rst
@@ -3,7 +3,125 @@
Commands
========
+This page contains documentation for each BuildStream command,
+along with their possible options and arguments. Each command can be
+invoked on the command line, where, in most cases, this will be from the
+project's main directory.
+
+
+----
+
+.. The bst options e.g. bst --version, or bst --verbose etc.
+.. _invoking_bst:
.. click:: buildstream._frontend:cli
:prog: bst
- :show-nested:
+
+.. Further description of the command goes here
+
+----
+
+.. the `bst init` command
+.. _invoking_init:
+
+.. click:: buildstream._frontend.cli:init
+ :prog: bst init
+
+----
+
+.. the `bst build` command
+.. _invoking_build:
+
+.. click:: buildstream._frontend.cli:build
+ :prog: bst build
+
+----
+
+.. _invoking_fetch:
+
+.. click:: buildstream._frontend.cli:fetch
+ :prog: bst fetch
+
+----
+
+.. _invoking_track:
+
+.. click:: buildstream._frontend.cli:track
+ :prog: bst track
+
+----
+
+.. _invoking_pull:
+
+.. click:: buildstream._frontend.cli:pull
+ :prog: bst pull
+
+----
+
+.. _invoking_push:
+
+.. click:: buildstream._frontend.cli:push
+ :prog: bst push
+
+----
+
+.. _invoking_show:
+
+.. click:: buildstream._frontend.cli:show
+ :prog: bst show
+
+----
+
+.. _invoking_shell:
+
+.. click:: buildstream._frontend.cli:shell
+ :prog: bst shell
+
+----
+
+.. _invoking_checkout:
+
+.. click:: buildstream._frontend.cli:checkout
+ :prog: bst checkout
+
+----
+
+.. _invoking_source_bundle:
+
+.. click:: buildstream._frontend.cli:source_bundle
+ :prog: bst source bundle
+
+----
+
+.. _invoking_workspace:
+
+.. click:: buildstream._frontend.cli:workspace
+ :prog: bst workspace
+
+----
+
+.. _invoking_workspace_open:
+
+.. click:: buildstream._frontend.cli:workspace_open
+ :prog: bst workspace open
+
+----
+
+.. _invoking_workspace_close:
+
+.. click:: buildstream._frontend.cli:workspace_close
+ :prog: bst workspace close
+
+----
+
+.. _invoking_workspace_reset:
+
+.. click:: buildstream._frontend.cli:workspace_reset
+ :prog: bst workspace reset
+
+----
+
+.. _invoking_workspace_list:
+
+.. click:: buildstream._frontend.cli:workspace_list
+ :prog: bst workspace list