juergbi commented on code in PR #2147:
URL: https://github.com/apache/buildstream/pull/2147#discussion_r3988805600
##########
src/buildstream/_frontend/cli.py:
##########
@@ -748,13 +755,38 @@ def shell(
otherwise bst may respond to them instead. e.g.
\b
- bst shell example.bst -- df -h
+ bst shell base.bst -- df -h
Use the --build option to create a temporary sysroot for
building the element instead.
+ Use the --with option to stage the artifacts of other elements
+ into the temporary sysroot to make them available to run e.g.
+
+ \b
+ bst shell --with base.bst example.bst -- cat example.txt
+
If no COMMAND is specified, the default is to attempt
to run an interactive shell.
+
+ # Examples:
+
+ \b
+ # Attempt to run an interactive shell with example.bst
+ bst shell example.bst
+ # Attempt to run an df -h with example.bst
+ bst shell example.bst -- df h
+ # In a workspace directory, attempt to shell into the workspace element
+ bst shell
+ # Attempt to run cat from base.bst to read example.txt from example.bst
+ bst shell --with base.bst example.bst -- cat example.txt
+ # Attempt to run an interactive shell with the sources and all
dependencies of example.bst
+ bst shell --build example.bst
+
+ For all examples on this page:
+ - example.bst is a simple import element with no dependencies
+ that imports a file called example.txt
+ - base.bst provides a basic alpine sysroot with a standard set of unix
tooling (sh, df, cat etc).
Review Comment:
build_docs CI fails with
```
/home/testuser/buildstream/doc/source/using_commands.rst:42: WARNING: Block
quote ends without a blank line; unexpected unindent. [docutils]
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
