summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorTiago Gomes <tiago.gomes@codethink.co.uk>2018-07-16 16:45:16 +0100
committerTiago Gomes <tiago.gomes@codethink.co.uk>2018-07-20 12:25:35 +0100
commit90a204d50b4a2d14dc880531cfd7291fbdc8318f (patch)
tree0febc18faf6c588e8e0ae4779c3595ab1324d56c /man
parent21fb826dc90570914bb2e80a8348d408dec44be7 (diff)
downloadbuildstream-90a204d50b4a2d14dc880531cfd7291fbdc8318f.tar.gz
Add support for creating a tarball on bst checkouttiagogomes/tarball_checkout_1.2
One of the tests added is configured to be skipped for now, as dumping binary data is causing a bad descriptor exception when using the pytest capture module. Closes #263.
Diffstat (limited to 'man')
-rw-r--r--man/bst-checkout.112
1 files changed, 8 insertions, 4 deletions
diff --git a/man/bst-checkout.1 b/man/bst-checkout.1
index 7f213be82..fcd212e8d 100644
--- a/man/bst-checkout.1
+++ b/man/bst-checkout.1
@@ -3,14 +3,14 @@
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
.B bst checkout
-[OPTIONS] ELEMENT DIRECTORY
+[OPTIONS] ELEMENT LOCATION
.SH DESCRIPTION
-Checkout a built artifact to the specified directory
+Checkout a built artifact to the specified location
.SH OPTIONS
.TP
\fB\-f,\fP \-\-force
-Overwrite files existing in checkout directory
+Allow files to be overwritten
.TP
\fB\-d,\fP \-\-deps [run|none]
The dependencies to checkout (default: run)
@@ -19,4 +19,8 @@ The dependencies to checkout (default: run)
Whether to run integration commands
.TP
\fB\-\-hardlinks\fP
-Checkout hardlinks instead of copies (handle with care) \ No newline at end of file
+Checkout hardlinks instead of copies (handle with care)
+.TP
+\fB\-\-tar\fP
+Create a tarball from the artifact contents instead of a file tree. If
+LOCATION is '-', the tarball will be dumped to the standard output.