diff options
| author | bst-marge-bot <marge-bot@buildstream.build> | 2019-11-19 09:55:24 +0000 |
|---|---|---|
| committer | bst-marge-bot <marge-bot@buildstream.build> | 2019-11-19 09:55:24 +0000 |
| commit | 497ded27a786283ea7939a76891d131de0be5375 (patch) | |
| tree | e38a18e28260a1f94e35385567f4b64e7b52e9a1 | |
| parent | 26670d5dd6d08e0af187f9eeb33413495fbe9fa0 (diff) | |
| parent | 64839c972753821ef4aa0d31dad00d520aaffab9 (diff) | |
| download | buildstream-497ded27a786283ea7939a76891d131de0be5375.tar.gz | |
Merge branch 'traveltissues/1170' into 'master'
Improve help message for workspace soft-reset
Closes #1170
See merge request BuildStream/buildstream!1710
| -rw-r--r-- | src/buildstream/_frontend/cli.py | 6 | ||||
| -rw-r--r-- | src/buildstream/_stream.py | 2 |
2 files changed, 6 insertions, 2 deletions
diff --git a/src/buildstream/_frontend/cli.py b/src/buildstream/_frontend/cli.py index 935a492d9..b6c126b34 100644 --- a/src/buildstream/_frontend/cli.py +++ b/src/buildstream/_frontend/cli.py @@ -1049,7 +1049,11 @@ def workspace_close(app, remove_dir, all_, elements): # Workspace Reset Command # ################################################################## @workspace.command(name="reset", short_help="Reset a workspace to its original state") -@click.option("--soft", is_flag=True, help="Reset workspace state without affecting its contents") +@click.option( + "--soft", + is_flag=True, + help="Mark workspace to re-execute configuration steps (if any) on next build. Does not alter workspace contents.", +) @click.option("--track", "track_", is_flag=True, help="Track and fetch the latest source before resetting") @click.option("--all", "-a", "all_", is_flag=True, help="Reset all open workspaces") @click.argument("elements", nargs=-1, type=click.Path(readable=False)) diff --git a/src/buildstream/_stream.py b/src/buildstream/_stream.py index 676c57426..e0a8d92bb 100644 --- a/src/buildstream/_stream.py +++ b/src/buildstream/_stream.py @@ -961,7 +961,7 @@ class Stream: # # Args: # targets (list of str): The target elements to reset the workspace for - # soft (bool): Only reset workspace state + # soft (bool): Only set the workspace state to not prepared # track_first (bool): Whether to also track the sources first # def workspace_reset(self, targets, *, soft, track_first): |