diff --git a/doc/source/developing/workspaces.rst b/doc/source/developing/workspaces.rst index db2c9a95e..b22f68c36 100644 --- a/doc/source/developing/workspaces.rst +++ b/doc/source/developing/workspaces.rst @@ -105,7 +105,7 @@ where build scripts automatically detect sources in it's configuration phase, so newly added sources you add might be ignored. In order to force the configuration step to be called again on the next build, -you can use :ref:`bst workspace reset --soft `, like so: +you can use :ref:`bst workspace reset \\\\-\\\\-soft `, like so: In these cases, you can perform a hard reset on the workspace using :ref:`bst workspace reset `, like so: diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst index 1822a8bdd..cfdb8ac82 100644 --- a/doc/source/format_project.rst +++ b/doc/source/format_project.rst @@ -159,7 +159,7 @@ following to your ``project.conf``: When using the ``project.refs`` file, it is possible to override the references in subprojects by editing the ``project.refs`` file directly - or by using :ref:`bst source track --cross-junctions `, + or by using :ref:`bst source track \\\\-\\\\-cross-junctions `, this can be practical to try out fresher versions of components which are maintained in a subproject. @@ -320,7 +320,7 @@ they are defined when fetching, and in reverse-order when tracking. The mirrors can be overridden on a per project basis using :ref:`user configuration `. One can also specify which mirror should be used first in the :ref:`user configuration `, or using -the :ref:`--default-mirror ` command-line argument. +the :ref:`\\\\-\\\\-default-mirror ` command-line argument. If you want this project's mirrors to also be used for subprojects, see :ref:`Mapping source aliases of subprojects `. @@ -635,7 +635,7 @@ dictionary. default: False Project options can be specified on the command line using -:ref:`bst --option ... ` +:ref:`bst \\\\-\\\\-option ... ` .. note:: diff --git a/src/buildstream/buildelement.py b/src/buildstream/buildelement.py index aebe5fb0b..b98177599 100644 --- a/src/buildstream/buildelement.py +++ b/src/buildstream/buildelement.py @@ -76,7 +76,7 @@ In the case that the element is currently workspaced, the ``configure-commands`` will only be run in subsequent builds until they succeed at least once, unless - :ref:`bst workspace reset --soft ` is called on the + :ref:`bst workspace reset \\\\\\\\-\\\\\\\\-soft ` is called on the workspace to explicitly avoid an incremental build. """ diff --git a/src/buildstream/plugins/sources/workspace.py b/src/buildstream/plugins/sources/workspace.py index 5c16ad47e..895c775ed 100644 --- a/src/buildstream/plugins/sources/workspace.py +++ b/src/buildstream/plugins/sources/workspace.py @@ -39,7 +39,7 @@ .. attention:: Observing a SourceInfo with the ``SourceInfoMedium.WORKSPACE`` in the output of - :ref:`bst show --format %{source-info} ` is most likely undesirable, given + :ref:`bst show \\\\\\\\-\\\\\\\\-format %{source-info} ` is most likely undesirable, given that you are likely interested in observing the source provenance information of the project in a clean state rather than in a state with open workspaces. """