Commit 1d84bb80 authored by Tristan Van Berkom's avatar Tristan Van Berkom

doc/source/tutorial/running-commands.rst: Added tip about using `--` in `bst shell`

parent 4b499ba3
......@@ -208,6 +208,16 @@ the ``hello.bst`` element. This was done by staging all of the dependencies of
with all of the dependencies was staged and ready, we ran the ``hello`` command from
within the build sandbox environment.
.. tip::
When specifying a command for :ref:`bst shell <invoking_shell>` to run,
we always specify ``--`` first. This is a commonly understood shell syntax
to indicate that the remaining arguments are to be treated literally.
Specifying ``--`` is optional and disambiguates BuildStream's arguments
and options from those of the program being run by
:ref:`bst shell <invoking_shell>`.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment