fix(docs): update workspace reset --soft to avoid smart-quotes#2136
Open
kotborealis wants to merge 1 commit into
Open
fix(docs): update workspace reset --soft to avoid smart-quotes#2136kotborealis wants to merge 1 commit into
workspace reset --soft to avoid smart-quotes#2136kotborealis wants to merge 1 commit into
Conversation
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`.
kotborealis
requested review from
BenjaminSchubert,
abderrahim,
cs-shadow,
gtristan and
juergbi
as code owners
June 23, 2026 13:32
Contributor
|
I think this looks ok to go: @abderrahim @juergbi ok to merge? |
abderrahim
approved these changes
Jul 19, 2026
kotborealis
added a commit
to kotborealis/buildstream
that referenced
this pull request
Jul 19, 2026
When using `bst workspace reset --all a.bst b.bst c.bst`, list of elements is ignored and it resets all workspaces, which could be confusing. This patch adds a check that either `--all` is specified or list of elementsis provided. This also fixes the following strange problem: Running `bst workspace reset --all --soft` (with en-dash in `--soft`) causes buildstream to parse it as: reset with `all` flag and with list of elements `--soft`, as it could not parse it as a flag due to en-dash. This leads to bst hard-resetting workspace when for user it seems like he requested the `--soft`-one. Now bst would throw error that either `--all` or element list needs to be provided, and would not reset user changes to workspace. Ref. apache#2136
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In docs for incremental builds and buildelement
--softturned 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:
This patch fixes docs so sphinx would not render it as
en-dash: moved--softoutside of:ref:, as I could not get it to work otherwise.