summaryrefslogtreecommitdiff
path: root/man/bst-source-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-source-checkout.1
parent077d5a96fe82afb11238fc4e19166e07f9667ad0 (diff)
downloadbuildstream-jennis/migrate_pull_push_commands.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-source-checkout.1')
-rw-r--r--man/bst-source-checkout.119
1 files changed, 14 insertions, 5 deletions
diff --git a/man/bst-source-checkout.1 b/man/bst-source-checkout.1
index 115a77afb..7afbc9394 100644
--- a/man/bst-source-checkout.1
+++ b/man/bst-source-checkout.1
@@ -1,14 +1,17 @@
-.TH "BST SOURCE-CHECKOUT" "1" "29-Nov-2018" "" "bst source-checkout Manual"
+.TH "BST SOURCE CHECKOUT" "1" "22-Jan-2019" "" "bst source checkout Manual"
.SH NAME
-bst\-source-checkout \- Checkout sources for an element
+bst\-source\-checkout \- Checkout sources for an element
.SH SYNOPSIS
-.B bst source-checkout
-[OPTIONS] ELEMENT LOCATION
+.B bst source checkout
+[OPTIONS] [ELEMENT] [LOCATION]
.SH DESCRIPTION
Checkout sources of an element to the specified location
.SH OPTIONS
.TP
+\fB\-f,\fP \-\-force
+Allow files to be overwritten
+.TP
\fB\-\-except\fP PATH
Except certain dependencies
.TP
@@ -16,4 +19,10 @@ Except certain dependencies
The dependencies whose sources to checkout (default: none)
.TP
\fB\-\-fetch\fP
-Fetch elements if they are not fetched \ No newline at end of file
+Fetch elements if they are not fetched
+.TP
+\fB\-\-tar\fP
+Create a tarball from the element's sources instead of a file tree.
+.TP
+\fB\-\-include\-build\-scripts\fP
+.PP \ No newline at end of file