summaryrefslogtreecommitdiff
path: root/man/bst-checkout.1
diff options
context:
space:
mode:
authorJames Ennis <james.ennis@codethink.com>2019-01-22 13:02:14 +0000
committerJames Ennis <james.ennis@codethink.com>2019-01-22 13:02:14 +0000
commitea2fbe4d69b7d3b214175620271a148510b75a19 (patch)
tree58133bc7dd8c95f0177e91750656a1b511e93362 /man/bst-checkout.1
parent077d5a96fe82afb11238fc4e19166e07f9667ad0 (diff)
downloadbuildstream-ea2fbe4d69b7d3b214175620271a148510b75a19.tar.gz
man: Regenerate all of our man pagesjennis/migrate_pull_push_commands
Due to an upstream click_man issue: https://github.com/click-contrib/click-man/issues/10 generating the man pages with our current setup.py only generates a man page for bst-artifact-server, our first entry point. I then had to remove this entry point from setup.py and regenerate to obtain man pages for the commands in cli.py
Diffstat (limited to 'man/bst-checkout.1')
-rw-r--r--man/bst-checkout.19
1 files changed, 3 insertions, 6 deletions
diff --git a/man/bst-checkout.1 b/man/bst-checkout.1
index dbe7873f0..2482f94ef 100644
--- a/man/bst-checkout.1
+++ b/man/bst-checkout.1
@@ -1,18 +1,15 @@
-.TH "BST CHECKOUT" "1" "29-Nov-2018" "" "bst checkout Manual"
+.TH "BST CHECKOUT" "1" "22-Jan-2019" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
.B bst checkout
-[OPTIONS] ELEMENT LOCATION
-.SH DESCRIPTION
-Checkout a built artifact to the specified location
-
+[OPTIONS] [ELEMENT] [LOCATION]
.SH OPTIONS
.TP
\fB\-f,\fP \-\-force
Allow files to be overwritten
.TP
-\fB\-d,\fP \-\-deps [run|none]
+\fB\-d,\fP \-\-deps [run|build|none]
The dependencies to checkout (default: run)
.TP
\fB\-\-integrate\fP / \-\-no\-integrate