summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJames Ennis <james.ennis@codethink.com>2019-01-22 11:00:21 +0000
committerJames Ennis <james.ennis@codethink.com>2019-01-22 12:32:43 +0000
commit383142e3e566303d33890bdef4dd75a9fe3289ac (patch)
tree0a043a922fc22ea4b09ad5ca791d6ceff2b5089b /doc
parent638ceb8a081b76ab072f10ad876e528d95b95e42 (diff)
downloadbuildstream-383142e3e566303d33890bdef4dd75a9fe3289ac.tar.gz
using_commands.rst: Split out top level commands and subcommand groups
Diffstat (limited to 'doc')
-rw-r--r--doc/source/using_commands.rst42
1 files changed, 27 insertions, 15 deletions
diff --git a/doc/source/using_commands.rst b/doc/source/using_commands.rst
index 90d86dcbb..2f530ee3d 100644
--- a/doc/source/using_commands.rst
+++ b/doc/source/using_commands.rst
@@ -9,7 +9,8 @@ invoked on the command line, where, in most cases, this will be from the
project's main directory.
-----
+Top-level commands
+------------------
.. The bst options e.g. bst --version, or bst --verbose etc.
.. _invoking_bst:
@@ -37,20 +38,6 @@ project's main directory.
----
-.. _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
@@ -79,6 +66,13 @@ project's main directory.
----
+.. _invoking_source:
+
+.. click:: buildstream._frontend.cli:source
+ :prog: bst source
+
+----
+
.. _invoking_checkout:
.. click:: buildstream._frontend.cli:checkout
@@ -91,8 +85,26 @@ project's main directory.
.. click:: buildstream._frontend.cli:workspace
:prog: bst workspace
+
+Source subcommands
+------------------
+
+.. _invoking_source_fetch:
+
+.. click:: buildstream._frontend.cli:source_fetch
+ :prog: bst source fetch
+
----
+.. _invoking_source_track:
+
+.. click:: buildstream._frontend.cli:source_track
+ :prog: bst source track
+
+
+Workspace subcommands
+---------------------
+
.. _invoking_workspace_open:
.. click:: buildstream._frontend.cli:workspace_open