Commit d42d2ac6 authored by Tristan Van Berkom's avatar Tristan Van Berkom

Updated man pages after recent frontend changes.

parent da1c7541
.TH "BST BUILD" "1" "27-May-2017" "" "bst build Manual"
.TH "BST BUILD" "1" "28-May-2017" "" "bst build Manual"
.SH NAME
bst\-build \- Build elements in a pipeline
.SH SYNOPSIS
......@@ -11,6 +11,9 @@ Build elements in a pipeline
\fB\-\-all\fP
Build elements that would not be needed for the current build plan
.TP
\fB\-\-track\fP
Track new source references before building (implies --all)
.TP
\fB\-a,\fP \-\-arch TEXT
The target architecture (default: x86_64)
.TP
......
.TH "BST CHECKOUT" "1" "27-May-2017" "" "bst checkout Manual"
.TH "BST CHECKOUT" "1" "28-May-2017" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
......
.TH "BST FETCH" "1" "27-May-2017" "" "bst fetch Manual"
.TH "BST FETCH" "1" "28-May-2017" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
.B bst fetch
[OPTIONS] TARGET
.SH DESCRIPTION
Fetch sources in a pipeline
Fetch sources required to build the pipeline
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.
Specify `--deps` to control which sources to fetch:

none: No dependencies, just the element itself
plan: Only dependencies required for the build plan
all: All dependencies
.SH OPTIONS
.TP
\fB\-d,\fP \-\-deps [none|plan|all|build|run]
Specify a dependency scope to fetch (default: none)
\fB\-d,\fP \-\-deps [none|plan|all]
The dependencies to fetch (default: plan)
.TP
\fB\-a,\fP \-\-arch TEXT
The target architecture (default: x86_64)
......
.TH "BST SHELL" "1" "27-May-2017" "" "bst shell Manual"
.TH "BST SHELL" "1" "28-May-2017" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
......
.TH "BST SHOW" "1" "27-May-2017" "" "bst show Manual"
.TH "BST SHOW" "1" "28-May-2017" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
......@@ -7,8 +7,15 @@ bst\-show \- Show elements in the pipeline
.SH DESCRIPTION
Show elements in the pipeline
By default this will only show the specified element, use
the --deps option to show an entire pipeline.
By default this will show all of the dependencies of the
specified target element.
Specify `--deps` to control which elements to show:

none: No dependencies, just the element itself
plan: Only dependencies required for the build plan
all: All dependencies

FORMAT
......@@ -41,8 +48,8 @@ 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|build|run]
Specify a dependency scope to show (default: none)
\fB\-d,\fP \-\-deps [none|plan|all]
The dependencies to show (default: all)
.TP
\fB\-\-order\fP [stage|alpha]
Staging or alphabetic ordering of dependencies
......
.TH "BST TRACK" "1" "27-May-2017" "" "bst track Manual"
.TH "BST TRACK" "1" "28-May-2017" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
.B bst track
[OPTIONS] TARGET
.SH DESCRIPTION
Track new source references
Consults the specified tracking branches for new versions available
to build and updates the project with any newly available references.
Updates the project with new source references from
any sources which are configured to track a remote
branch or tag.
By default this will track sources for all dependencies of the specified
target element.
The project data will be rewritten inline.
Specify `--deps` to control which sources to track:

none: No dependencies, just the element itself
all: All dependencies
.SH OPTIONS
.TP
\fB\-d,\fP \-\-deps [none|plan|all|build|run]
Specify a dependency scope to track (default: none)
\fB\-d,\fP \-\-deps [none|all]
The dependencies to track (default: all)
.TP
\fB\-a,\fP \-\-arch TEXT
The target architecture (default: x86_64)
......
.TH "BST" "1" "27-May-2017" "" "bst Manual"
.TH "BST" "1" "28-May-2017" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
......@@ -48,31 +48,31 @@ 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
\fBbuild\fP
Build elements in a pipeline
See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command.
\fBtrack\fP
Track new source references
See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
.PP
\fBshow\fP
Show elements in the pipeline
See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command.
\fBcheckout\fP
Checkout a built artifact
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.
.PP
\fBtrack\fP
Track new source references
See \fBbst-track(1)\fP for full documentation on the \fBtrack\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
\fBcheckout\fP
Checkout a built artifact
See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
\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.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment