summaryrefslogtreecommitdiff
path: root/man/bst-artifact-checkout.1
diff options
context:
space:
mode:
authorChandan Singh <csingh43@bloomberg.net>2019-01-24 21:13:15 +0000
committerChandan Singh <chandan@chandansingh.net>2019-01-25 23:50:49 +0000
commitd74386886a1ca53a394dc80c1a29c777e087398a (patch)
tree62acfb0a853787ea2f5dcd997ca787e481c92464 /man/bst-artifact-checkout.1
parent89ba2abe538bfc5fd9fca77a71e5fb6e02f7039c (diff)
downloadbuildstream-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-artifact-checkout.1')
-rw-r--r--man/bst-artifact-checkout.17
1 files changed, 5 insertions, 2 deletions
diff --git a/man/bst-artifact-checkout.1 b/man/bst-artifact-checkout.1
index 9d1bf5534..e928a3048 100644
--- a/man/bst-artifact-checkout.1
+++ b/man/bst-artifact-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT CHECKOUT" "1" "22-Jan-2019" "" "bst artifact checkout Manual"
+.TH "BST ARTIFACT CHECKOUT" "1" "24-Jan-2019" "" "bst artifact checkout Manual"
.SH NAME
bst\-artifact\-checkout \- Checkout contents of an artifact
.SH SYNOPSIS
@@ -6,6 +6,9 @@ bst\-artifact\-checkout \- Checkout contents of an artifact
[OPTIONS] [ELEMENT]
.SH DESCRIPTION
Checkout contents of an artifact
+.PP
+When this command is executed from a workspace directory, the default
+is to checkout the artifact of the workspace element.
.SH OPTIONS
.TP
\fB\-f,\fP \-\-force
@@ -24,4 +27,4 @@ Checkout hardlinks instead of copying if possible
Create a tarball from the artifact contents instead of a file tree. If LOCATION is '-', the tarball will be dumped to the standard output.
.TP
\fB\-\-directory\fP DIRECTORY
-The directory to checkout the artifact to \ No newline at end of file
+The directory to checkout the artifact to