Commit 7bc2e070 authored by Tristan Van Berkom's avatar Tristan Van Berkom

Generating man pages

Including changes for newly added bst push & pull
commands and also some changes to the shell command.
parent be295512
Pipeline #11650393 passed with stages
in 26 minutes and 40 seconds
.TH "BST-ARTIFACT-RECEIVE" "1" "27-Jul-2017" "" "bst-artifact-receive Manual"
.TH "BST-ARTIFACT-RECEIVE" "1" "10-Sep-2017" "" "bst-artifact-receive Manual"
.SH NAME
bst-artifact-receive \- Receive pushed artifacts over ssh
.SH SYNOPSIS
......
.TH "BST BUILD" "1" "27-Jul-2017" "" "bst build Manual"
.TH "BST BUILD" "1" "10-Sep-2017" "" "bst build Manual"
.SH NAME
bst\-build \- Build elements in a pipeline
.SH SYNOPSIS
......
.TH "BST CHECKOUT" "1" "27-Jul-2017" "" "bst checkout Manual"
.TH "BST CHECKOUT" "1" "10-Sep-2017" "" "bst checkout Manual"
.SH NAME
bst\-checkout \- Checkout a built artifact
.SH SYNOPSIS
......
.TH "BST FETCH" "1" "27-Jul-2017" "" "bst fetch Manual"
.TH "BST FETCH" "1" "10-Sep-2017" "" "bst fetch Manual"
.SH NAME
bst\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
......
.TH "BST PULL" "1" "10-Sep-2017" "" "bst pull Manual"
.SH NAME
bst\-pull \- Pull a built artifact
.SH SYNOPSIS
.B bst pull
[OPTIONS] TARGET
.SH DESCRIPTION
Pull a built artifact from the configured remote artifact cache.
Specify `--deps` to control which artifacts to pull:

none: No dependencies, just the element itself
all: All dependencies
.SH OPTIONS
.TP
\fB\-\-variant\fP TEXT
A variant of the specified target
.TP
\fB\-d,\fP \-\-deps [none|all]
The dependency artifacts to pull (default: none)
\ No newline at end of file
.TH "BST PUSH" "1" "10-Sep-2017" "" "bst push Manual"
.SH NAME
bst\-push \- Push a built artifact
.SH SYNOPSIS
.B bst push
[OPTIONS] TARGET
.SH DESCRIPTION
Push a built artifact to the configured remote artifact cache.
Specify `--deps` to control which artifacts to push:

none: No dependencies, just the element itself
all: All dependencies
.SH OPTIONS
.TP
\fB\-\-variant\fP TEXT
A variant of the specified target
.TP
\fB\-d,\fP \-\-deps [none|all]
The dependencies to push (default: none)
\ No newline at end of file
.TH "BST SHELL" "1" "27-Jul-2017" "" "bst shell Manual"
.TH "BST SHELL" "1" "10-Sep-2017" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
.B bst shell
[OPTIONS] TARGET
[OPTIONS] TARGET [COMMAND]...
.SH DESCRIPTION
Shell into an element's sandbox environment
Run a command in the target element's sandbox environment
This can be used either to debug building or to launch
test and debug successful build results.
This will first stage a temporary sysroot for running
the target element, assuming it has already been built
and all required artifacts are in the local cache.
Use the --builddir option with an existing build directory
or use the --scope option instead to create a new staging
area automatically.
Use the --build option to create a temporary sysroot for
building the element instead.
Use the --sysroot option with an existing failed build
directory or with a checkout of the given target, in order
to use a specific sysroot.
If no COMMAND is specified, the default is to attempt
to run an interactive shell with `sh -i`.
.SH OPTIONS
.TP
\fB\-b,\fP \-\-builddir DIRECTORY
Existing build directory
\fB\-b,\fP \-\-build
Create a build sandbox
.TP
\fB\-s,\fP \-\-scope [build|run]
Specify element scope to stage
\fB\-s,\fP \-\-sysroot DIRECTORY
An existing sysroot
.TP
\fB\-\-variant\fP TEXT
A variant of the specified target
\ No newline at end of file
.TH "BST SHOW" "1" "27-Jul-2017" "" "bst show Manual"
.TH "BST SHOW" "1" "10-Sep-2017" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
......
.TH "BST SOURCE-BUNDLE" "1" "27-Jul-2017" "" "bst source-bundle Manual"
.TH "BST SOURCE-BUNDLE" "1" "10-Sep-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
Produce a source bundle to be manually executed
.SH OPTIONS
.TP
\fB\-\-except\fP TEXT
......@@ -21,9 +14,6 @@ Elements to except from the tarball
\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
......
.TH "BST TRACK" "1" "27-Jul-2017" "" "bst track Manual"
.TH "BST TRACK" "1" "10-Sep-2017" "" "bst track Manual"
.SH NAME
bst\-track \- Track new source references
.SH SYNOPSIS
......
.TH "BST WORKSPACE CLOSE" "1" "27-Jul-2017" "" "bst workspace close Manual"
.TH "BST WORKSPACE CLOSE" "1" "10-Sep-2017" "" "bst workspace close Manual"
.SH NAME
bst\-workspace\-close \- Close a workspace
.SH SYNOPSIS
......@@ -8,7 +8,7 @@ bst\-workspace\-close \- Close a workspace
Close a workspace
.SH OPTIONS
.TP
\fB\-s,\fP \-\-source TEXT
\fB\-s,\fP \-\-source INDEX
The source of the workspace to remove. Projects with one source may omit this
.TP
\fB\-\-remove\-dir\fP
......
.TH "BST WORKSPACE LIST" "1" "27-Jul-2017" "" "bst workspace list Manual"
.TH "BST WORKSPACE LIST" "1" "10-Sep-2017" "" "bst workspace list Manual"
.SH NAME
bst\-workspace\-list \- List open workspaces
.SH SYNOPSIS
......
.TH "BST WORKSPACE OPEN" "1" "27-Jul-2017" "" "bst workspace open Manual"
.TH "BST WORKSPACE OPEN" "1" "10-Sep-2017" "" "bst workspace open Manual"
.SH NAME
bst\-workspace\-open \- Open a new workspace
.SH SYNOPSIS
......@@ -14,7 +14,7 @@ Do not checkout the source, only link to the given directory
\fB\-f,\fP \-\-force
Overwrite files existing in checkout directory
.TP
\fB\-s,\fP \-\-source TEXT
\fB\-s,\fP \-\-source INDEX
The source to create a workspace for. Projects with one source may omit this
.TP
\fB\-\-variant\fP TEXT
......
.TH "BST WORKSPACE RESET" "1" "27-Jul-2017" "" "bst workspace reset Manual"
.TH "BST WORKSPACE RESET" "1" "10-Sep-2017" "" "bst workspace reset Manual"
.SH NAME
bst\-workspace\-reset \- Reset a workspace to its original state
.SH SYNOPSIS
......@@ -8,7 +8,7 @@ bst\-workspace\-reset \- Reset a workspace to its original state
Reset a workspace to its original state
.SH OPTIONS
.TP
\fB\-s,\fP \-\-source TEXT
\fB\-s,\fP \-\-source INDEX
The source of the workspace to reset. Projects with one source may omit this
.TP
\fB\-\-track\fP
......@@ -18,7 +18,4 @@ Track and fetch the latest source before resetting
Do not checkout the source, only link to the given directory
.TP
\fB\-\-variant\fP TEXT
A variant of the specified target
.TP
\fB\-\-yes\fP
Confirm the action without prompting.
\ No newline at end of file
A variant of the specified target
\ No newline at end of file
.TH "BST WORKSPACE" "1" "27-Jul-2017" "" "bst workspace Manual"
.TH "BST WORKSPACE" "1" "10-Sep-2017" "" "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
\fBclose\fP
Close a workspace
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.
.PP
\fBlist\fP
List open workspaces
See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command.
.PP
\fBclose\fP
Close a workspace
See \fBbst workspace-close(1)\fP for full documentation on the \fBclose\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
\fBopen\fP
Open a new workspace
See \fBbst workspace-open(1)\fP for full documentation on the \fBopen\fP command.
.TH "BST" "1" "27-Jul-2017" "" "bst Manual"
.TH "BST" "1" "10-Sep-2017" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
......@@ -14,7 +14,7 @@ user preferences configuration file.
\fB\-\-version\fP
Show the version and exit.
.TP
\fB\-c,\fP \-\-config FILE
\fB\-c,\fP \-\-config PATH
Configuration file to use
.TP
\fB\-C,\fP \-\-directory DIRECTORY
......@@ -68,20 +68,35 @@ Machine architecture for build output (defaults to --arch)
\fB\-\-strict\fP / \-\-no\-strict
Elements must be rebuilt when their dependencies have changed
.SH COMMANDS
.PP
\fBbuild\fP
Build elements in a pipeline
See \fBbst-build(1)\fP for full documentation on the \fBbuild\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.
\fBcheckout\fP
Checkout a built artifact
See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
.PP
\fBtrack\fP
Track new source references
See \fBbst-track(1)\fP for full documentation on the \fBtrack\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
Manipulate developer workspaces
See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
.PP
\fBpull\fP
Pull a built artifact
See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command.
.PP
\fBshow\fP
......@@ -94,16 +109,11 @@ Elements must be rebuilt when their dependencies have changed
See \fBbst-source-bundle(1)\fP for full documentation on the \fBsource-bundle\fP command.
.PP
\fBfetch\fP
Fetch sources in a pipeline
See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
\fBpush\fP
Push a built artifact
See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command.
.PP
\fBcheckout\fP
Checkout a built artifact
See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
.PP
\fBworkspace\fP
Manipulate developer workspaces
See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command.
\fBtrack\fP
Track new source references
See \fBbst-track(1)\fP for full documentation on the \fBtrack\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