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.avv@gmail.com>2018-07-20 09:07:01 +0000
commit9c1f024b15849fae1d8512c0215e4fb0b24fc311 (patch)
tree0a2216e961e5b4a5f8eebb6bf1eab087719916a1 /man
parent790fb40b75075c9af64798df3aa54fd4d8fe140e (diff)
downloadbuildstream-9c1f024b15849fae1d8512c0215e4fb0b24fc311.tar.gz
Add support for creating a tarball on bst checkouttiagogomes/tarball_checkout
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.110
1 files changed, 7 insertions, 3 deletions
diff --git a/man/bst-checkout.1 b/man/bst-checkout.1
index 1a9829624..243bdaa30 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\-f,\fP \-\-deps
The dependencies to checkout (default: run)
@@ -20,3 +20,7 @@ Whether to run integration commands
.TP
\fB\-\-hardlinks\fP
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.