diff options
| author | Chandan Singh <csingh43@bloomberg.net> | 2019-01-24 21:13:15 +0000 |
|---|---|---|
| committer | Chandan Singh <chandan@chandansingh.net> | 2019-01-25 23:50:49 +0000 |
| commit | d74386886a1ca53a394dc80c1a29c777e087398a (patch) | |
| tree | 62acfb0a853787ea2f5dcd997ca787e481c92464 /man/bst-shell.1 | |
| parent | 89ba2abe538bfc5fd9fca77a71e5fb6e02f7039c (diff) | |
| download | buildstream-d74386886a1ca53a394dc80c1a29c777e087398a.tar.gz | |
man: Refresh man pages
Notable changes:
* New `source` and `artifact` command groups
* Man pages corresponding to obsolete commands, that were marked as
hidden in Click, have now been removed.
Fixes #881.
Diffstat (limited to 'man/bst-shell.1')
| -rw-r--r-- | man/bst-shell.1 | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/man/bst-shell.1 b/man/bst-shell.1 index 5f806e453..37303c18b 100644 --- a/man/bst-shell.1 +++ b/man/bst-shell.1 @@ -1,4 +1,4 @@ -.TH "BST SHELL" "1" "22-Jan-2019" "" "bst shell Manual" +.TH "BST SHELL" "1" "24-Jan-2019" "" "bst shell Manual" .SH NAME bst\-shell \- Shell into an element's sandbox environment .SH SYNOPSIS @@ -7,6 +7,9 @@ bst\-shell \- Shell into an element's sandbox environment .SH DESCRIPTION Run a command in the target element's sandbox environment .PP +When this command is executed from a workspace directory, the default +is to shell into the workspace element. +.PP This will stage a temporary sysroot for running the target element, assuming it has already been built and all required artifacts are in the local cache. @@ -41,4 +44,4 @@ Mount a file or directory into the sandbox Create an isolated build sandbox .TP \fB\-t,\fP \-\-use\-buildtree [ask|try|always|never] -Defaults to ask but if set to always the function will fail if a build tree is not available
\ No newline at end of file +Defaults to ask but if set to always the function will fail if a build tree is not available |