summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-07-04 20:04:46 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-07-04 20:04:46 +0900
commitc513bb1ea83f76212cf6b91943147b8aa7146b5f (patch)
treedc9bd7b7c6ab81d468137e24bf5627e61423dde8 /man
parentf6d3f961bec54a51311df407b27a5b0b39be8f02 (diff)
downloadbuildstream-c513bb1ea83f76212cf6b91943147b8aa7146b5f.tar.gz
Regenerating man pages with recent options
Diffstat (limited to 'man')
-rw-r--r--man/bst-build.12
-rw-r--r--man/bst-checkout.12
-rw-r--r--man/bst-fetch.12
-rw-r--r--man/bst-shell.12
-rw-r--r--man/bst-show.16
-rw-r--r--man/bst-source-bundle.140
-rw-r--r--man/bst-track.18
-rw-r--r--man/bst.135
8 files changed, 74 insertions, 23 deletions
diff --git a/man/bst-build.1 b/man/bst-build.1
index 6b36e25df..c1c26ce5c 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "21-Jun-2017" "" "bst build Manual"
+.TH "BST BUILD" "1" "04-Jul-2017" "" "bst build Manual"
.SH NAME
bst\-build \- Build elements in a pipeline
.SH SYNOPSIS
diff --git a/man/bst-checkout.1 b/man/bst-checkout.1
index 33d8f1a0a..8de2b70f6 100644
--- a/man/bst-checkout.1
+++ b/man/bst-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST CHECKOUT" "1" "21-Jun-2017" "" "bst checkout Manual"
+.TH "BST CHECKOUT" "1" "04-Jul-2017" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
diff --git a/man/bst-fetch.1 b/man/bst-fetch.1
index 5fe9a3270..5e6afe580 100644
--- a/man/bst-fetch.1
+++ b/man/bst-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST FETCH" "1" "21-Jun-2017" "" "bst fetch Manual"
+.TH "BST FETCH" "1" "04-Jul-2017" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index 0bfab2e46..99d035d71 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "21-Jun-2017" "" "bst shell Manual"
+.TH "BST SHELL" "1" "04-Jul-2017" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
diff --git a/man/bst-show.1 b/man/bst-show.1
index d37d35a88..def19c5a8 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "21-Jun-2017" "" "bst show Manual"
+.TH "BST SHOW" "1" "04-Jul-2017" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
@@ -40,13 +40,13 @@ as a pythonic formatting string, so python formatting features apply,
examle:

- build-stream show target.bst --format \
+ bst show target.bst --format \
'Name: %{name: ^20} Key: %{key: ^8} State: %{state}'
If you want to use a newline in a format string in bash, use the '$' modifier:

- build-stream show target.bst --format \
+ bst show target.bst --format \
$'---------- %{name} ----------\n%{vars}'
.SH OPTIONS
.TP
diff --git a/man/bst-source-bundle.1 b/man/bst-source-bundle.1
new file mode 100644
index 000000000..d161113a7
--- /dev/null
+++ b/man/bst-source-bundle.1
@@ -0,0 +1,40 @@
+.TH "BST SOURCE-BUNDLE" "1" "04-Jul-2017" "" "bst source-bundle Manual"
+.SH NAME
+bst\-source-bundle \- Produce a build bundle to be manually executed
+.SH SYNOPSIS
+.B bst source-bundle
+[OPTIONS] TARGET
+.SH DESCRIPTION
+Produce a build bundle to be manually executed
+
+Specify `--deps` to control which elements to show:
+
+
+ none: No dependencies, just the element itself
+ run: Runtime dependencies, including the element itself
+ build: Build time dependencies, excluding the element itself
+.SH OPTIONS
+.TP
+\fB\-\-except\fP TEXT
+Elements to except from the tarball
+.TP
+\fB\-\-compression\fP [none|gz|bz2|xz]
+Compress the tar file using the given algorithm.
+.TP
+\fB\-d,\fP \-\-deps [none|run|build]
+The elements to bundle (default: build)
+.TP
+\fB\-\-track\fP
+Track new source references before building
+.TP
+\fB\-a,\fP \-\-arch TEXT
+The target architecture (default: x86_64)
+.TP
+\fB\-\-variant\fP TEXT
+A variant of the specified target
+.TP
+\fB\-f,\fP \-\-force
+Overwrite files existing in checkout directory
+.TP
+\fB\-\-directory\fP TEXT
+The directory to write the tarball to \ No newline at end of file
diff --git a/man/bst-track.1 b/man/bst-track.1
index 3b2f04da6..7d5d2e25b 100644
--- a/man/bst-track.1
+++ b/man/bst-track.1
@@ -1,4 +1,4 @@
-.TH "BST TRACK" "1" "21-Jun-2017" "" "bst track Manual"
+.TH "BST TRACK" "1" "04-Jul-2017" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
@@ -8,8 +8,8 @@ bst\-track \- Track new source references
Consults the specified tracking branches for new versions available
to build and updates the project with any newly available references.
-By default this will track sources for all dependencies of the specified
-target element.
+By default this will track just the specified element, but you can also
+update a whole tree of dependencies in one go.
Specify `--deps` to control which sources to track:
@@ -22,7 +22,7 @@ Specify `--deps` to control which sources to track:
Except certain dependencies from tracking
.TP
\fB\-d,\fP \-\-deps [none|all]
-The dependencies to track (default: all)
+The dependencies to track (default: none)
.TP
\fB\-a,\fP \-\-arch TEXT
The target architecture (default: x86_64)
diff --git a/man/bst.1 b/man/bst.1
index 8bcc2f449..a119c3d9c 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "21-Jun-2017" "" "bst Manual"
+.TH "BST" "1" "04-Jul-2017" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
@@ -29,6 +29,9 @@ Maximum simultaneous download tasks
\fB\-\-builders\fP INTEGER
Maximum simultaneous build tasks
.TP
+\fB\-\-pushers\fP INTEGER
+Maximum simultaneous upload tasks
+.TP
\fB\-\-no\-interactive\fP
Force non interactive mode, otherwise this is automatically decided
.TP
@@ -46,11 +49,19 @@ Maximum number of lines to show in a detailed message
.TP
\fB\-\-log\-file\fP FILENAME
A file to store the main log (allows storing the main log while in interactive mode)
+.TP
+\fB\-\-colors\fP / \-\-no\-colors
+Force enable/disable ANSI color codes in output
.SH COMMANDS
.PP
-\fBfetch\fP
- Fetch sources in a pipeline
- See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
+\fBsource-bundle\fP
+ Produce a build bundle to be manually executed
+ See \fBbst-source-bundle(1)\fP for full documentation on the \fBsource-bundle\fP command.
+
+.PP
+\fBshow\fP
+ Show elements in the pipeline
+ See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
.PP
\fBbuild\fP
@@ -58,19 +69,19 @@ A file to store the main log (allows storing the main log while in interactive m
See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command.
.PP
-\fBtrack\fP
- Track new source references
- See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
-
-.PP
\fBcheckout\fP
Checkout a built artifact
See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
.PP
-\fBshow\fP
- Show elements in the pipeline
- See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
+\fBfetch\fP
+ Fetch sources in a pipeline
+ See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
+
+.PP
+\fBtrack\fP
+ Track new source references
+ See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
.PP
\fBshell\fP