diff options
author | James Ennis <james.ennis@codethink.com> | 2019-01-22 13:02:14 +0000 |
---|---|---|
committer | James Ennis <james.ennis@codethink.com> | 2019-01-22 13:02:14 +0000 |
commit | ea2fbe4d69b7d3b214175620271a148510b75a19 (patch) | |
tree | 58133bc7dd8c95f0177e91750656a1b511e93362 /man/bst-source-fetch.1 | |
parent | 077d5a96fe82afb11238fc4e19166e07f9667ad0 (diff) | |
download | buildstream-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-source-fetch.1')
-rw-r--r-- | man/bst-source-fetch.1 | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/man/bst-source-fetch.1 b/man/bst-source-fetch.1 new file mode 100644 index 000000000..6168f5f92 --- /dev/null +++ b/man/bst-source-fetch.1 @@ -0,0 +1,33 @@ +.TH "BST SOURCE FETCH" "1" "22-Jan-2019" "" "bst source fetch Manual" +.SH NAME +bst\-source\-fetch \- Fetch sources in a pipeline +.SH SYNOPSIS +.B bst source fetch +[OPTIONS] [ELEMENTS]... +.SH DESCRIPTION +Fetch sources required to build the pipeline +.PP +By default this will only try to fetch sources which are +required for the build plan of the specified target element, +omitting sources for any elements which are already built +and available in the artifact cache. +.PP +Specify `--deps` to control which sources to fetch: +.PP + + none: No dependencies, just the element itself + plan: Only dependencies required for the build plan + all: All dependencies +.SH OPTIONS +.TP +\fB\-\-except\fP PATH +Except certain dependencies from fetching +.TP +\fB\-d,\fP \-\-deps [none|plan|all] +The dependencies to fetch (default: plan) +.TP +\fB\-\-track\fP +Track new source references before fetching +.TP +\fB\-J,\fP \-\-track\-cross\-junctions +Allow tracking to cross junction boundaries
\ No newline at end of file |