summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-08-06 19:27:08 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-08-06 19:34:49 +0900
commit0c57cdda9ee98c9601b2944958338a02dfefcbb8 (patch)
tree564f57f79900471411f78265dacbda1e41f3d721
parent38cf132e9204d32e5ef73236c0f633fcdbc993f6 (diff)
downloadbuildstream-0c57cdda9ee98c9601b2944958338a02dfefcbb8.tar.gz
man: Updating man pages for the upcoming 1.1.5 release1.1.5
-rw-r--r--man/bst-build.12
-rw-r--r--man/bst-checkout.15
-rw-r--r--man/bst-fetch.12
-rw-r--r--man/bst-help.12
-rw-r--r--man/bst-init.14
-rw-r--r--man/bst-pull.12
-rw-r--r--man/bst-push.12
-rw-r--r--man/bst-shell.12
-rw-r--r--man/bst-show.12
-rw-r--r--man/bst-source-bundle.12
-rw-r--r--man/bst-track.12
-rw-r--r--man/bst-workspace-close.12
-rw-r--r--man/bst-workspace-list.12
-rw-r--r--man/bst-workspace-open.12
-rw-r--r--man/bst-workspace-reset.12
-rw-r--r--man/bst-workspace.118
-rw-r--r--man/bst.167
17 files changed, 61 insertions, 59 deletions
diff --git a/man/bst-build.1 b/man/bst-build.1
index eb74ec790..81a866494 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "18-Jul-2018" "" "bst build Manual"
+.TH "BST BUILD" "1" "06-Aug-2018" "" "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 fcd212e8d..aa3ff5913 100644
--- a/man/bst-checkout.1
+++ b/man/bst-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST CHECKOUT" "1" "18-Jul-2018" "" "bst checkout Manual"
+.TH "BST CHECKOUT" "1" "06-Aug-2018" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
@@ -22,5 +22,4 @@ Whether to run integration commands
Checkout hardlinks instead of copies (handle with care)
.TP
\fB\-\-tar\fP
-Create a tarball from the artifact contents instead of a file tree. If
-LOCATION is '-', the tarball will be dumped to the standard output.
+Create a tarball from the artifact contents instead of a file tree. If LOCATION is '-', the tarball will be dumped to the standard output. \ No newline at end of file
diff --git a/man/bst-fetch.1 b/man/bst-fetch.1
index a4dbe3193..97ee37741 100644
--- a/man/bst-fetch.1
+++ b/man/bst-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST FETCH" "1" "18-Jul-2018" "" "bst fetch Manual"
+.TH "BST FETCH" "1" "06-Aug-2018" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
diff --git a/man/bst-help.1 b/man/bst-help.1
index 9774ab4cf..655e5b438 100644
--- a/man/bst-help.1
+++ b/man/bst-help.1
@@ -1,4 +1,4 @@
-.TH "BST HELP" "1" "18-Jul-2018" "" "bst help Manual"
+.TH "BST HELP" "1" "06-Aug-2018" "" "bst help Manual"
.SH NAME
bst\-help \- Print usage information
.SH SYNOPSIS
diff --git a/man/bst-init.1 b/man/bst-init.1
index 8a2b1ba97..73dbed15d 100644
--- a/man/bst-init.1
+++ b/man/bst-init.1
@@ -1,4 +1,4 @@
-.TH "BST INIT" "1" "18-Jul-2018" "" "bst init Manual"
+.TH "BST INIT" "1" "06-Aug-2018" "" "bst init Manual"
.SH NAME
bst\-init \- Initialize a new BuildStream project
.SH SYNOPSIS
@@ -18,7 +18,7 @@ interactive session.
The project name to use
.TP
\fB\-\-format\-version\fP INTEGER
-The required format version (default: 9)
+The required format version (default: 12)
.TP
\fB\-\-element\-path\fP PATH
The subdirectory to store elements in (default: elements)
diff --git a/man/bst-pull.1 b/man/bst-pull.1
index 078c2eb61..e3adda1b9 100644
--- a/man/bst-pull.1
+++ b/man/bst-pull.1
@@ -1,4 +1,4 @@
-.TH "BST PULL" "1" "18-Jul-2018" "" "bst pull Manual"
+.TH "BST PULL" "1" "06-Aug-2018" "" "bst pull Manual"
.SH NAME
bst\-pull \- Pull a built artifact
.SH SYNOPSIS
diff --git a/man/bst-push.1 b/man/bst-push.1
index a70f1585b..9721a8781 100644
--- a/man/bst-push.1
+++ b/man/bst-push.1
@@ -1,4 +1,4 @@
-.TH "BST PUSH" "1" "18-Jul-2018" "" "bst push Manual"
+.TH "BST PUSH" "1" "06-Aug-2018" "" "bst push Manual"
.SH NAME
bst\-push \- Push a built artifact
.SH SYNOPSIS
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index 1f1b6b8a5..09e5b6da8 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "18-Jul-2018" "" "bst shell Manual"
+.TH "BST SHELL" "1" "06-Aug-2018" "" "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 1bbc25f40..4495bf21d 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "18-Jul-2018" "" "bst show Manual"
+.TH "BST SHOW" "1" "06-Aug-2018" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
diff --git a/man/bst-source-bundle.1 b/man/bst-source-bundle.1
index 575ecc2a0..ce94dde7e 100644
--- a/man/bst-source-bundle.1
+++ b/man/bst-source-bundle.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE-BUNDLE" "1" "18-Jul-2018" "" "bst source-bundle Manual"
+.TH "BST SOURCE-BUNDLE" "1" "06-Aug-2018" "" "bst source-bundle Manual"
.SH NAME
bst\-source-bundle \- Produce a build bundle to be manually executed
.SH SYNOPSIS
diff --git a/man/bst-track.1 b/man/bst-track.1
index b06bee820..98fa311b0 100644
--- a/man/bst-track.1
+++ b/man/bst-track.1
@@ -1,4 +1,4 @@
-.TH "BST TRACK" "1" "18-Jul-2018" "" "bst track Manual"
+.TH "BST TRACK" "1" "06-Aug-2018" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
diff --git a/man/bst-workspace-close.1 b/man/bst-workspace-close.1
index 1de08b333..4abaad358 100644
--- a/man/bst-workspace-close.1
+++ b/man/bst-workspace-close.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE CLOSE" "1" "18-Jul-2018" "" "bst workspace close Manual"
+.TH "BST WORKSPACE CLOSE" "1" "06-Aug-2018" "" "bst workspace close Manual"
.SH NAME
bst\-workspace\-close \- Close workspaces
.SH SYNOPSIS
diff --git a/man/bst-workspace-list.1 b/man/bst-workspace-list.1
index 401fa53d7..e2e67c4eb 100644
--- a/man/bst-workspace-list.1
+++ b/man/bst-workspace-list.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE LIST" "1" "18-Jul-2018" "" "bst workspace list Manual"
+.TH "BST WORKSPACE LIST" "1" "06-Aug-2018" "" "bst workspace list Manual"
.SH NAME
bst\-workspace\-list \- List open workspaces
.SH SYNOPSIS
diff --git a/man/bst-workspace-open.1 b/man/bst-workspace-open.1
index 7bf37b215..a0fae85b7 100644
--- a/man/bst-workspace-open.1
+++ b/man/bst-workspace-open.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE OPEN" "1" "18-Jul-2018" "" "bst workspace open Manual"
+.TH "BST WORKSPACE OPEN" "1" "06-Aug-2018" "" "bst workspace open Manual"
.SH NAME
bst\-workspace\-open \- Open a new workspace
.SH SYNOPSIS
diff --git a/man/bst-workspace-reset.1 b/man/bst-workspace-reset.1
index b6e9807fc..29689a9c6 100644
--- a/man/bst-workspace-reset.1
+++ b/man/bst-workspace-reset.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE RESET" "1" "18-Jul-2018" "" "bst workspace reset Manual"
+.TH "BST WORKSPACE RESET" "1" "06-Aug-2018" "" "bst workspace reset Manual"
.SH NAME
bst\-workspace\-reset \- Reset a workspace to its original state
.SH SYNOPSIS
diff --git a/man/bst-workspace.1 b/man/bst-workspace.1
index 9de32744a..b249ed4d5 100644
--- a/man/bst-workspace.1
+++ b/man/bst-workspace.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE" "1" "18-Jul-2018" "" "bst workspace Manual"
+.TH "BST WORKSPACE" "1" "06-Aug-2018" "" "bst workspace Manual"
.SH NAME
bst\-workspace \- Manipulate developer workspaces
.SH SYNOPSIS
@@ -8,21 +8,21 @@ bst\-workspace \- Manipulate developer workspaces
Manipulate developer workspaces
.SH COMMANDS
.PP
-\fBopen\fP
- Open a new workspace
- See \fBbst workspace-open(1)\fP for full documentation on the \fBopen\fP command.
-
-.PP
\fBreset\fP
Reset a workspace to its original state
See \fBbst workspace-reset(1)\fP for full documentation on the \fBreset\fP command.
.PP
+\fBclose\fP
+ Close workspaces
+ See \fBbst workspace-close(1)\fP for full documentation on the \fBclose\fP command.
+
+.PP
\fBlist\fP
List open workspaces
See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command.
.PP
-\fBclose\fP
- Close workspaces
- See \fBbst workspace-close(1)\fP for full documentation on the \fBclose\fP command.
+\fBopen\fP
+ Open a new workspace
+ See \fBbst workspace-open(1)\fP for full documentation on the \fBopen\fP command.
diff --git a/man/bst.1 b/man/bst.1
index d920b35f1..dfe1a7d2c 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "18-Jul-2018" "" "bst Manual"
+.TH "BST" "1" "06-Aug-2018" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
@@ -61,31 +61,29 @@ Elements must be rebuilt when their dependencies have changed
.TP
\fB\-o,\fP \-\-option OPTION VALUE
Specify a project option
+.TP
+\fB\-\-default\-mirror\fP TEXT
+The mirror to fetch from first, before attempting other mirrors
.SH COMMANDS
.PP
-\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
-\fBhelp\fP
- Print usage information
- See \fBbst-help(1)\fP for full documentation on the \fBhelp\fP command.
+\fBshow\fP
+ Show elements in the pipeline
+ See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
.PP
-\fBinit\fP
- Initialize a new BuildStream project
- See \fBbst-init(1)\fP for full documentation on the \fBinit\fP command.
+\fBpush\fP
+ Push a built artifact
+ See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command.
.PP
-\fBtrack\fP
- Track new source references
- See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
+\fBcheckout\fP
+ Checkout a built artifact
+ See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
.PP
-\fBpull\fP
- Pull a built artifact
- See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command.
+\fBfetch\fP
+ Fetch sources in a pipeline
+ See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
.PP
\fBworkspace\fP
@@ -98,9 +96,19 @@ Specify a project option
See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command.
.PP
-\fBcheckout\fP
- Checkout a built artifact
- See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
+\fBtrack\fP
+ Track new source references
+ See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
+
+.PP
+\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
+\fBinit\fP
+ Initialize a new BuildStream project
+ See \fBbst-init(1)\fP for full documentation on the \fBinit\fP command.
.PP
\fBshell\fP
@@ -108,16 +116,11 @@ Specify a project option
See \fBbst-shell(1)\fP for full documentation on the \fBshell\fP command.
.PP
-\fBfetch\fP
- Fetch sources in a pipeline
- See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
-
-.PP
-\fBpush\fP
- Push a built artifact
- See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command.
+\fBpull\fP
+ Pull a built artifact
+ See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command.
.PP
-\fBshow\fP
- Show elements in the pipeline
- See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
+\fBhelp\fP
+ Print usage information
+ See \fBbst-help(1)\fP for full documentation on the \fBhelp\fP command.