summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-06-21 18:16:40 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-06-21 18:16:40 +0900
commit2fd1fc03950c19c3e6dedab9dc088bd704dbe35c (patch)
tree50d2254c1aac961a78d9ea6bcea3fb579a6c4db7 /man
parent85c5d6aa522d13c2e452027b51d786eddda76dee (diff)
downloadbuildstream-2fd1fc03950c19c3e6dedab9dc088bd704dbe35c.tar.gz
Updating man pages to reflect recent frontend changes.
Diffstat (limited to 'man')
-rw-r--r--man/bst-build.12
-rw-r--r--man/bst-checkout.12
-rw-r--r--man/bst-fetch.18
-rw-r--r--man/bst-shell.12
-rw-r--r--man/bst-show.111
-rw-r--r--man/bst-track.15
-rw-r--r--man/bst.128
7 files changed, 36 insertions, 22 deletions
diff --git a/man/bst-build.1 b/man/bst-build.1
index b739c6f89..6b36e25df 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "28-May-2017" "" "bst build Manual"
+.TH "BST BUILD" "1" "21-Jun-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 a88e46b9a..33d8f1a0a 100644
--- a/man/bst-checkout.1
+++ b/man/bst-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST CHECKOUT" "1" "28-May-2017" "" "bst checkout Manual"
+.TH "BST CHECKOUT" "1" "21-Jun-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 1c4b148b5..5fe9a3270 100644
--- a/man/bst-fetch.1
+++ b/man/bst-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST FETCH" "1" "28-May-2017" "" "bst fetch Manual"
+.TH "BST FETCH" "1" "21-Jun-2017" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
@@ -20,9 +20,15 @@ Specify `--deps` to control which sources to fetch:
all: All dependencies
.SH OPTIONS
.TP
+\fB\-\-except\fP TEXT
+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\-a,\fP \-\-arch TEXT
The target architecture (default: x86_64)
.TP
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index 9f65c01cb..0bfab2e46 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "28-May-2017" "" "bst shell Manual"
+.TH "BST SHELL" "1" "21-Jun-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 980985055..d37d35a88 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "28-May-2017" "" "bst show Manual"
+.TH "BST SHOW" "1" "21-Jun-2017" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
@@ -14,7 +14,9 @@ Specify `--deps` to control which elements to show:

none: No dependencies, just the element itself
- plan: Only dependencies required for the build plan
+ plan: Dependencies required for a build plan
+ run: Runtime dependencies, including the element itself
+ build: Build time dependencies, excluding the element itself
all: All dependencies

@@ -48,7 +50,10 @@ If you want to use a newline in a format string in bash, use the '$' modifier:
$'---------- %{name} ----------\n%{vars}'
.SH OPTIONS
.TP
-\fB\-d,\fP \-\-deps [none|plan|all]
+\fB\-\-except\fP TEXT
+Except certain dependencies
+.TP
+\fB\-d,\fP \-\-deps [none|plan|run|build|all]
The dependencies to show (default: all)
.TP
\fB\-\-order\fP [stage|alpha]
diff --git a/man/bst-track.1 b/man/bst-track.1
index fac8e725c..3b2f04da6 100644
--- a/man/bst-track.1
+++ b/man/bst-track.1
@@ -1,4 +1,4 @@
-.TH "BST TRACK" "1" "28-May-2017" "" "bst track Manual"
+.TH "BST TRACK" "1" "21-Jun-2017" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
@@ -18,6 +18,9 @@ Specify `--deps` to control which sources to track:
all: All dependencies
.SH OPTIONS
.TP
+\fB\-\-except\fP TEXT
+Except certain dependencies from tracking
+.TP
\fB\-d,\fP \-\-deps [none|all]
The dependencies to track (default: all)
.TP
diff --git a/man/bst.1 b/man/bst.1
index c03772d1d..8bcc2f449 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "28-May-2017" "" "bst Manual"
+.TH "BST" "1" "21-Jun-2017" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
@@ -48,6 +48,16 @@ Maximum number of lines to show in a detailed message
A file to store the main log (allows storing the main log while in interactive mode)
.SH COMMANDS
.PP
+\fBfetch\fP
+ Fetch sources in a pipeline
+ See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
+
+.PP
+\fBbuild\fP
+ Build elements in a pipeline
+ 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.
@@ -58,21 +68,11 @@ A file to store the main log (allows storing the main log while in interactive m
See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
.PP
-\fBfetch\fP
- Fetch sources in a pipeline
- See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
+\fBshow\fP
+ Show elements in the pipeline
+ See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
.PP
\fBshell\fP
Shell into an element's sandbox environment
See \fBbst-shell(1)\fP for full documentation on the \fBshell\fP command.
-
-.PP
-\fBbuild\fP
- Build elements in a pipeline
- See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command.
-
-.PP
-\fBshow\fP
- Show elements in the pipeline
- See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.