From 41df7cbb4308483bbdf5443e1a4b41d380d1e28e Mon Sep 17 00:00:00 2001 From: kotborealis Date: Tue, 23 Jun 2026 16:25:20 +0300 Subject: [PATCH] fix(docs): update `workspace reset --soft` to avoid smart-quotes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In docs for incremental builds and buildelement `--soft` turned into `–soft`, which is ignored by CLI parser. This lead to running `bst workspace reset –-soft --all` (with en-dash) by copypasting it, which turned out to hard-reset of workspaces. See: * https://docs.buildstream.build/2.5/developing/workspaces.html#incremental-builds:~:text=bst%20workspace%20reset-,%E2%80%93soft%2C,-like%20so%3A * https://docs.buildstream.build/2.5/buildstream.buildelement.html#:~:text=bst%20workspace%20reset-,%E2%80%93soft,-is%20called%20on This patch fixes docs so sphinx would not render it as `en-dash`. --- doc/source/developing/workspaces.rst | 4 ++-- src/buildstream/buildelement.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/developing/workspaces.rst b/doc/source/developing/workspaces.rst index db2c9a95e..e7621e0c6 100644 --- a/doc/source/developing/workspaces.rst +++ b/doc/source/developing/workspaces.rst @@ -105,7 +105,8 @@ 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 ` with the +``--soft`` option, like so: In these cases, you can perform a hard reset on the workspace using :ref:`bst workspace reset `, like so: @@ -147,4 +148,3 @@ To discard the workspace completely we can do: This will close the workspace and completely remove the workspace_hello directory. - diff --git a/src/buildstream/buildelement.py b/src/buildstream/buildelement.py index aebe5fb0b..752732375 100644 --- a/src/buildstream/buildelement.py +++ b/src/buildstream/buildelement.py @@ -76,8 +76,8 @@ 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 - workspace to explicitly avoid an incremental build. + :ref:`bst workspace reset ` is called with the + ``--soft`` option on the workspace to explicitly avoid an incremental build. """