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-artifact-push.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-artifact-push.1')
-rw-r--r-- | man/bst-artifact-push.1 | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/man/bst-artifact-push.1 b/man/bst-artifact-push.1 new file mode 100644 index 000000000..5ede66917 --- /dev/null +++ b/man/bst-artifact-push.1 @@ -0,0 +1,28 @@ +.TH "BST ARTIFACT PUSH" "1" "22-Jan-2019" "" "bst artifact push Manual" +.SH NAME +bst\-artifact\-push \- Push a built artifact +.SH SYNOPSIS +.B bst artifact push +[OPTIONS] [ELEMENTS]... +.SH DESCRIPTION +Push a built artifact to a remote artifact cache. +.PP +The default destination is the highest priority configured cache. You can +override this by passing a different cache URL with the `--remote` flag. +.PP +If bst has been configured to include build trees on artifact pulls, +an attempt will be made to pull any required build trees to avoid the +skipping of partial artifacts being pushed. +.PP +Specify `--deps` to control which artifacts to push: +.PP + + none: No dependencies, just the element itself + all: All dependencies +.SH OPTIONS +.TP +\fB\-d,\fP \-\-deps [none|all] +The dependencies to push (default: none) +.TP +\fB\-r,\fP \-\-remote TEXT +The URL of the remote cache (defaults to the first configured cache)
\ No newline at end of file |