diff options
author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-03-06 21:42:41 +0900 |
---|---|---|
committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-03-06 21:42:41 +0900 |
commit | ec5ee795f6b730e1013edb2faff60e07041a9cd3 (patch) | |
tree | dac2339e6b74dea3b9107d1a306c898a835d45ec /man | |
parent | 1f63d214270cd46bcdba4b42dcbd7cc2fc2ea00c (diff) | |
download | buildstream-ec5ee795f6b730e1013edb2faff60e07041a9cd3.tar.gz |
man: Updated man pages for the release1.1.1
Diffstat (limited to 'man')
-rw-r--r-- | man/bst-artifact-receive.1 | 2 | ||||
-rw-r--r-- | man/bst-build.1 | 2 | ||||
-rw-r--r-- | man/bst-checkout.1 | 2 | ||||
-rw-r--r-- | man/bst-fetch.1 | 2 | ||||
-rw-r--r-- | man/bst-pull.1 | 2 | ||||
-rw-r--r-- | man/bst-push.1 | 2 | ||||
-rw-r--r-- | man/bst-shell.1 | 20 | ||||
-rw-r--r-- | man/bst-show.1 | 2 | ||||
-rw-r--r-- | man/bst-source-bundle.1 | 2 | ||||
-rw-r--r-- | man/bst-track.1 | 2 | ||||
-rw-r--r-- | man/bst-workspace-close.1 | 2 | ||||
-rw-r--r-- | man/bst-workspace-list.1 | 2 | ||||
-rw-r--r-- | man/bst-workspace-open.1 | 2 | ||||
-rw-r--r-- | man/bst-workspace-reset.1 | 2 | ||||
-rw-r--r-- | man/bst-workspace.1 | 12 | ||||
-rw-r--r-- | man/bst.1 | 48 |
16 files changed, 56 insertions, 50 deletions
diff --git a/man/bst-artifact-receive.1 b/man/bst-artifact-receive.1 index 475a4d6a9..fedd675de 100644 --- a/man/bst-artifact-receive.1 +++ b/man/bst-artifact-receive.1 @@ -1,4 +1,4 @@ -.TH "BST-ARTIFACT-RECEIVE" "1" "19-Feb-2018" "" "bst-artifact-receive Manual" +.TH "BST-ARTIFACT-RECEIVE" "1" "06-Mar-2018" "" "bst-artifact-receive Manual" .SH NAME bst-artifact-receive \- Receive pushed artifacts over ssh .SH SYNOPSIS diff --git a/man/bst-build.1 b/man/bst-build.1 index ed03acc9d..be6e4f5ff 100644 --- a/man/bst-build.1 +++ b/man/bst-build.1 @@ -1,4 +1,4 @@ -.TH "BST BUILD" "1" "19-Feb-2018" "" "bst build Manual" +.TH "BST BUILD" "1" "06-Mar-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 6276bd5ab..a14c2390f 100644 --- a/man/bst-checkout.1 +++ b/man/bst-checkout.1 @@ -1,4 +1,4 @@ -.TH "BST CHECKOUT" "1" "19-Feb-2018" "" "bst checkout Manual" +.TH "BST CHECKOUT" "1" "06-Mar-2018" "" "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 c2cae276d..1d77279c5 100644 --- a/man/bst-fetch.1 +++ b/man/bst-fetch.1 @@ -1,4 +1,4 @@ -.TH "BST FETCH" "1" "19-Feb-2018" "" "bst fetch Manual" +.TH "BST FETCH" "1" "06-Mar-2018" "" "bst fetch Manual" .SH NAME bst\-fetch \- Fetch sources in a pipeline .SH SYNOPSIS diff --git a/man/bst-pull.1 b/man/bst-pull.1 index 5fc82f9c8..6d0b8d7a7 100644 --- a/man/bst-pull.1 +++ b/man/bst-pull.1 @@ -1,4 +1,4 @@ -.TH "BST PULL" "1" "19-Feb-2018" "" "bst pull Manual" +.TH "BST PULL" "1" "06-Mar-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 0625e124f..3c7da4640 100644 --- a/man/bst-push.1 +++ b/man/bst-push.1 @@ -1,4 +1,4 @@ -.TH "BST PUSH" "1" "19-Feb-2018" "" "bst push Manual" +.TH "BST PUSH" "1" "06-Mar-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 236b571ee..09c8f108c 100644 --- a/man/bst-shell.1 +++ b/man/bst-shell.1 @@ -1,4 +1,4 @@ -.TH "BST SHELL" "1" "19-Feb-2018" "" "bst shell Manual" +.TH "BST SHELL" "1" "06-Mar-2018" "" "bst shell Manual" .SH NAME bst\-shell \- Shell into an element's sandbox environment .SH SYNOPSIS @@ -7,9 +7,9 @@ bst\-shell \- Shell into an element's sandbox environment .SH DESCRIPTION Run a command in the target element's sandbox environment -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. +This will 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 --build option to create a temporary sysroot for building the element instead. @@ -19,11 +19,17 @@ 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`. +to run an interactive shell. .SH OPTIONS .TP \fB\-b,\fP \-\-build -Create a build sandbox +Stage dependencies and sources to build .TP \fB\-s,\fP \-\-sysroot DIRECTORY -An existing sysroot
\ No newline at end of file +An existing sysroot +.TP +\fB\-\-mount\fP HOSTPATH PATH +Mount a file or directory into the sandbox +.TP +\fB\-\-isolate\fP +Create an isolated build sandbox
\ No newline at end of file diff --git a/man/bst-show.1 b/man/bst-show.1 index 35f6b8e73..2a87b36ec 100644 --- a/man/bst-show.1 +++ b/man/bst-show.1 @@ -1,4 +1,4 @@ -.TH "BST SHOW" "1" "19-Feb-2018" "" "bst show Manual" +.TH "BST SHOW" "1" "06-Mar-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 34063c045..975395582 100644 --- a/man/bst-source-bundle.1 +++ b/man/bst-source-bundle.1 @@ -1,4 +1,4 @@ -.TH "BST SOURCE-BUNDLE" "1" "19-Feb-2018" "" "bst source-bundle Manual" +.TH "BST SOURCE-BUNDLE" "1" "06-Mar-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 c65c7a229..ff8edd6e3 100644 --- a/man/bst-track.1 +++ b/man/bst-track.1 @@ -1,4 +1,4 @@ -.TH "BST TRACK" "1" "19-Feb-2018" "" "bst track Manual" +.TH "BST TRACK" "1" "06-Mar-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 af00b3ab2..a2cf11294 100644 --- a/man/bst-workspace-close.1 +++ b/man/bst-workspace-close.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE CLOSE" "1" "19-Feb-2018" "" "bst workspace close Manual" +.TH "BST WORKSPACE CLOSE" "1" "06-Mar-2018" "" "bst workspace close Manual" .SH NAME bst\-workspace\-close \- Close a workspace .SH SYNOPSIS diff --git a/man/bst-workspace-list.1 b/man/bst-workspace-list.1 index ebb2930e0..f23997fe0 100644 --- a/man/bst-workspace-list.1 +++ b/man/bst-workspace-list.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE LIST" "1" "19-Feb-2018" "" "bst workspace list Manual" +.TH "BST WORKSPACE LIST" "1" "06-Mar-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 0620a4e94..d344656f7 100644 --- a/man/bst-workspace-open.1 +++ b/man/bst-workspace-open.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE OPEN" "1" "19-Feb-2018" "" "bst workspace open Manual" +.TH "BST WORKSPACE OPEN" "1" "06-Mar-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 6576cdd64..38ce6a6fd 100644 --- a/man/bst-workspace-reset.1 +++ b/man/bst-workspace-reset.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE RESET" "1" "19-Feb-2018" "" "bst workspace reset Manual" +.TH "BST WORKSPACE RESET" "1" "06-Mar-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 c40d4fca1..9c2ab0b7e 100644 --- a/man/bst-workspace.1 +++ b/man/bst-workspace.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE" "1" "19-Feb-2018" "" "bst workspace Manual" +.TH "BST WORKSPACE" "1" "06-Mar-2018" "" "bst workspace Manual" .SH NAME bst\-workspace \- Manipulate developer workspaces .SH SYNOPSIS @@ -8,11 +8,6 @@ bst\-workspace \- Manipulate developer workspaces Manipulate developer workspaces .SH COMMANDS .PP -\fBlist\fP - List open workspaces - See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\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. @@ -23,6 +18,11 @@ Manipulate developer 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 \fBopen\fP Open a new workspace See \fBbst workspace-open(1)\fP for full documentation on the \fBopen\fP command. @@ -1,4 +1,4 @@ -.TH "BST" "1" "19-Feb-2018" "" "bst Manual" +.TH "BST" "1" "06-Mar-2018" "" "bst Manual" .SH NAME bst \- Build and manipulate BuildStream projects... .SH SYNOPSIS @@ -59,18 +59,13 @@ Force enable/disable ANSI color codes in output \fB\-\-strict\fP / \-\-no\-strict Elements must be rebuilt when their dependencies have changed .TP -\fB\-o,\fP \-\-option <TEXT TEXT>... +\fB\-o,\fP \-\-option OPTION VALUE Specify a project option .SH COMMANDS .PP -\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. +\fBshow\fP + Show elements in the pipeline + See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command. .PP \fBtrack\fP @@ -78,14 +73,14 @@ Specify a project option 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. +\fBpush\fP + Push a built artifact + See \fBbst-push(1)\fP for full documentation on the \fBpush\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. +\fBworkspace\fP + Manipulate developer workspaces + See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command. .PP \fBbuild\fP @@ -93,19 +88,24 @@ Specify a project option See \fBbst-build(1)\fP for full documentation on the \fBbuild\fP command. .PP +\fBfetch\fP + Fetch sources in a pipeline + See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command. + +.PP +\fBcheckout\fP + Checkout a built artifact + See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\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 -\fBpush\fP - Push a built artifact - See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command. - -.PP -\fBshow\fP - Show elements in the pipeline - See \fBbst-show(1)\fP for full documentation on the \fBshow\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 \fBpull\fP |