diff options
| author | James Ennis <james.ennis@codethink.com> | 2019-01-22 12:04:38 +0000 |
|---|---|---|
| committer | James Ennis <james.ennis@codethink.com> | 2019-01-22 12:38:40 +0000 |
| commit | 1bccf1d25b55e1eae2baa42d8bdb2db6af075137 (patch) | |
| tree | f5ecf5b0f7f0646994750ce85dda833018ff920a | |
| parent | 9e8034e9a5d88956b0f4d4df82bd793c200b0795 (diff) | |
| download | buildstream-1bccf1d25b55e1eae2baa42d8bdb2db6af075137.tar.gz | |
using_commands.rst: Split out the artifact subcommands
| -rw-r--r-- | doc/source/tutorial/first-project.rst | 2 | ||||
| -rw-r--r-- | doc/source/using_commands.rst | 49 | ||||
| -rw-r--r-- | doc/source/using_configuring_artifact_server.rst | 2 |
3 files changed, 31 insertions, 22 deletions
diff --git a/doc/source/tutorial/first-project.rst b/doc/source/tutorial/first-project.rst index 18df85bb7..c83e74030 100644 --- a/doc/source/tutorial/first-project.rst +++ b/doc/source/tutorial/first-project.rst @@ -108,7 +108,7 @@ as ``buildable`` in the :ref:`bst build <invoking_build>` command above, has now Observe the output ------------------ Now that we've finished building, we can checkout the output of the -artifact we've created using :ref:`bst checkout <invoking_checkout>` +artifact we've created using :ref:`bst artifact checkout <invoking_artifact_checkout>` .. raw:: html :file: ../sessions/first-project-checkout.html diff --git a/doc/source/using_commands.rst b/doc/source/using_commands.rst index 8e46d085a..a0303da76 100644 --- a/doc/source/using_commands.rst +++ b/doc/source/using_commands.rst @@ -22,6 +22,13 @@ Top-level commands ---- +.. _invoking_artifact: + +.. click:: buildstream._frontend.cli:artifact + :prog: bst artifact + +---- + .. the `bst init` command .. _invoking_init: @@ -38,20 +45,6 @@ Top-level commands ---- -.. _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 @@ -73,17 +66,33 @@ Top-level commands ---- -.. _invoking_checkout: +.. _invoking_workspace: + +.. click:: buildstream._frontend.cli:workspace + :prog: bst workspace + + +Artifact subcommands +-------------------- + +.. _invoking_artifact_checkout: + +.. click:: buildstream._frontend.cli:artifact_checkout + :prog: bst artifact checkout + +---- + +.. _invoking_artifact_pull: -.. click:: buildstream._frontend.cli:checkout - :prog: bst checkout +.. click:: buildstream._frontend.cli:artifact_pull + :prog: bst artifact pull ---- -.. _invoking_workspace: +.. _invoking_artifact_push: -.. click:: buildstream._frontend.cli:workspace - :prog: bst workspace +.. click:: buildstream._frontend.cli:artifact_push + :prog: bst artifact push Source subcommands diff --git a/doc/source/using_configuring_artifact_server.rst b/doc/source/using_configuring_artifact_server.rst index bcf7d0e16..da61f0f80 100644 --- a/doc/source/using_configuring_artifact_server.rst +++ b/doc/source/using_configuring_artifact_server.rst @@ -40,7 +40,7 @@ them in a specific order: When an artifact is built locally, BuildStream will try to push it to all the caches which have the ``push: true`` flag set. You can also manually push -artifacts to a specific cache using the :ref:`bst push command <invoking_push>`. +artifacts to a specific cache using the :ref:`bst artifact push command <invoking_artifact_push>`. Artifacts are identified using the element's :ref:`cache key <cachekeys>` so the builds provided by a cache should be interchangable with those provided |