diff options
| author | James Ennis <james.ennis@codethink.com> | 2019-01-22 11:00:21 +0000 |
|---|---|---|
| committer | James Ennis <james.ennis@codethink.com> | 2019-01-22 12:32:43 +0000 |
| commit | 383142e3e566303d33890bdef4dd75a9fe3289ac (patch) | |
| tree | 0a043a922fc22ea4b09ad5ca791d6ceff2b5089b | |
| parent | 638ceb8a081b76ab072f10ad876e528d95b95e42 (diff) | |
| download | buildstream-383142e3e566303d33890bdef4dd75a9fe3289ac.tar.gz | |
using_commands.rst: Split out top level commands and subcommand groups
| -rw-r--r-- | buildstream/source.py | 2 | ||||
| -rw-r--r-- | doc/source/using_commands.rst | 42 |
2 files changed, 28 insertions, 16 deletions
diff --git a/buildstream/source.py b/buildstream/source.py index f5cfeb1dd..9e9bad71c 100644 --- a/buildstream/source.py +++ b/buildstream/source.py @@ -396,7 +396,7 @@ class Source(Plugin): If the backend in question supports resolving references from a symbolic tracking branch or tag, then this should be implemented - to perform this task on behalf of :ref:`bst track <invoking_track>` + to perform this task on behalf of :ref:`bst source track <invoking_source_track>` commands. This usually requires fetching new content from a remote origin 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 |