diff options
-rw-r--r-- | man/bst-artifact-receive.1 | 2 | ||||
-rw-r--r-- | man/bst-build.1 | 5 | ||||
-rw-r--r-- | man/bst-checkout.1 | 2 | ||||
-rw-r--r-- | man/bst-fetch.1 | 7 | ||||
-rw-r--r-- | man/bst-init.1 | 27 | ||||
-rw-r--r-- | man/bst-pull.1 | 2 | ||||
-rw-r--r-- | man/bst-push.1 | 2 | ||||
-rw-r--r-- | man/bst-shell.1 | 2 | ||||
-rw-r--r-- | man/bst-show.1 | 2 | ||||
-rw-r--r-- | man/bst-source-bundle.1 | 3 | ||||
-rw-r--r-- | man/bst-track.1 | 11 | ||||
-rw-r--r-- | man/bst-workspace-close.1 | 11 | ||||
-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 | 8 | ||||
-rw-r--r-- | man/bst-workspace.1 | 20 | ||||
-rw-r--r-- | man/bst.1 | 59 |
17 files changed, 106 insertions, 61 deletions
diff --git a/man/bst-artifact-receive.1 b/man/bst-artifact-receive.1 index a9b428164..2874ded5b 100644 --- a/man/bst-artifact-receive.1 +++ b/man/bst-artifact-receive.1 @@ -1,4 +1,4 @@ -.TH "BST-ARTIFACT-RECEIVE" "1" "25-Mar-2018" "" "bst-artifact-receive Manual" +.TH "BST-ARTIFACT-RECEIVE" "1" "26-Apr-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 077269e7f..36f0b5cf6 100644 --- a/man/bst-build.1 +++ b/man/bst-build.1 @@ -1,4 +1,4 @@ -.TH "BST BUILD" "1" "25-Mar-2018" "" "bst build Manual" +.TH "BST BUILD" "1" "26-Apr-2018" "" "bst build Manual" .SH NAME bst\-build \- Build elements in a pipeline .SH SYNOPSIS @@ -20,5 +20,8 @@ Track all elements in the pipeline \fB\-\-track\-except\fP PATH Except certain dependencies from tracking .TP +\fB\-J,\fP \-\-track\-cross\-junctions +Allow tracking to cross junction boundaries +.TP \fB\-\-track\-save\fP Deprecated: This is ignored
\ No newline at end of file diff --git a/man/bst-checkout.1 b/man/bst-checkout.1 index 358c50c49..aaf14203c 100644 --- a/man/bst-checkout.1 +++ b/man/bst-checkout.1 @@ -1,4 +1,4 @@ -.TH "BST CHECKOUT" "1" "25-Mar-2018" "" "bst checkout Manual" +.TH "BST CHECKOUT" "1" "26-Apr-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 e82fe65b2..ca99671c8 100644 --- a/man/bst-fetch.1 +++ b/man/bst-fetch.1 @@ -1,4 +1,4 @@ -.TH "BST FETCH" "1" "25-Mar-2018" "" "bst fetch Manual" +.TH "BST FETCH" "1" "26-Apr-2018" "" "bst fetch Manual" .SH NAME bst\-fetch \- Fetch sources in a pipeline .SH SYNOPSIS @@ -27,4 +27,7 @@ Except certain dependencies from fetching The dependencies to fetch (default: plan) .TP \fB\-\-track\fP -Track new source references before fetching
\ No newline at end of file +Track new source references before fetching +.TP +\fB\-J,\fP \-\-track\-cross\-junctions +Allow tracking to cross junction boundaries
\ No newline at end of file diff --git a/man/bst-init.1 b/man/bst-init.1 new file mode 100644 index 000000000..0ec9abcf6 --- /dev/null +++ b/man/bst-init.1 @@ -0,0 +1,27 @@ +.TH "BST INIT" "1" "26-Apr-2018" "" "bst init Manual" +.SH NAME +bst\-init \- Initialize a new BuildStream project +.SH SYNOPSIS +.B bst init +[OPTIONS] +.SH DESCRIPTION +Initialize a new BuildStream project + +Creates a new BuildStream project.conf in the project +directory. + +Unless `--project-name` is specified, this will be an +interactive session. +.SH OPTIONS +.TP +\fB\-\-project\-name\fP TEXT +The project name to use +.TP +\fB\-\-format\-version\fP INTEGER +The required format version (default: 8) +.TP +\fB\-\-element\-path\fP PATH +The subdirectory to store elements in (default: elements) +.TP +\fB\-f,\fP \-\-force +Allow overwriting an existing project.conf
\ No newline at end of file diff --git a/man/bst-pull.1 b/man/bst-pull.1 index a57c411e2..bc582e4f0 100644 --- a/man/bst-pull.1 +++ b/man/bst-pull.1 @@ -1,4 +1,4 @@ -.TH "BST PULL" "1" "25-Mar-2018" "" "bst pull Manual" +.TH "BST PULL" "1" "26-Apr-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 84d25b022..b807b9d77 100644 --- a/man/bst-push.1 +++ b/man/bst-push.1 @@ -1,4 +1,4 @@ -.TH "BST PUSH" "1" "25-Mar-2018" "" "bst push Manual" +.TH "BST PUSH" "1" "26-Apr-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 9e0071f70..bc8b1164a 100644 --- a/man/bst-shell.1 +++ b/man/bst-shell.1 @@ -1,4 +1,4 @@ -.TH "BST SHELL" "1" "25-Mar-2018" "" "bst shell Manual" +.TH "BST SHELL" "1" "26-Apr-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 fd5ecbd8c..b82d0a396 100644 --- a/man/bst-show.1 +++ b/man/bst-show.1 @@ -1,4 +1,4 @@ -.TH "BST SHOW" "1" "25-Mar-2018" "" "bst show Manual" +.TH "BST SHOW" "1" "26-Apr-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 f49899761..92580aa9e 100644 --- a/man/bst-source-bundle.1 +++ b/man/bst-source-bundle.1 @@ -1,4 +1,4 @@ -.TH "BST SOURCE-BUNDLE" "1" "25-Mar-2018" "" "bst source-bundle Manual" +.TH "BST SOURCE-BUNDLE" "1" "26-Apr-2018" "" "bst source-bundle Manual" .SH NAME bst\-source-bundle \- Produce a build bundle to be manually executed .SH SYNOPSIS @@ -6,6 +6,7 @@ bst\-source-bundle \- Produce a build bundle to be manually executed [OPTIONS] TARGET .SH DESCRIPTION Produce a source bundle to be manually executed + .SH OPTIONS .TP \fB\-\-except\fP PATH diff --git a/man/bst-track.1 b/man/bst-track.1 index 259e4e16d..c32fc0abf 100644 --- a/man/bst-track.1 +++ b/man/bst-track.1 @@ -1,4 +1,4 @@ -.TH "BST TRACK" "1" "25-Mar-2018" "" "bst track Manual" +.TH "BST TRACK" "1" "26-Apr-2018" "" "bst track Manual" .SH NAME bst\-track \- Track new source references .SH SYNOPSIS @@ -14,12 +14,15 @@ update a whole tree of dependencies in one go. Specify `--deps` to control which sources to track: - none: No dependencies, just the element itself - all: All dependencies + none: No dependencies, just the specified elements + all: All dependencies of all specified elements .SH OPTIONS .TP \fB\-\-except\fP PATH Except certain dependencies from tracking .TP \fB\-d,\fP \-\-deps [none|all] -The dependencies to track (default: none)
\ No newline at end of file +The dependencies to track (default: none) +.TP +\fB\-J,\fP \-\-cross\-junctions +Allow crossing junction boundaries
\ No newline at end of file diff --git a/man/bst-workspace-close.1 b/man/bst-workspace-close.1 index 22662395a..c085b35ab 100644 --- a/man/bst-workspace-close.1 +++ b/man/bst-workspace-close.1 @@ -1,12 +1,15 @@ -.TH "BST WORKSPACE CLOSE" "1" "25-Mar-2018" "" "bst workspace close Manual" +.TH "BST WORKSPACE CLOSE" "1" "26-Apr-2018" "" "bst workspace close Manual" .SH NAME -bst\-workspace\-close \- Close a workspace +bst\-workspace\-close \- Close workspaces .SH SYNOPSIS .B bst workspace close -[OPTIONS] ELEMENT +[OPTIONS] [ELEMENTS]... .SH DESCRIPTION Close a workspace .SH OPTIONS .TP \fB\-\-remove\-dir\fP -Remove the path that contains the closed workspace
\ No newline at end of file +Remove the path that contains the closed workspace +.TP +\fB\-a,\fP \-\-all +Close all open workspaces
\ No newline at end of file diff --git a/man/bst-workspace-list.1 b/man/bst-workspace-list.1 index d3a796ef9..f07de2419 100644 --- a/man/bst-workspace-list.1 +++ b/man/bst-workspace-list.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE LIST" "1" "25-Mar-2018" "" "bst workspace list Manual" +.TH "BST WORKSPACE LIST" "1" "26-Apr-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 428b59037..926430729 100644 --- a/man/bst-workspace-open.1 +++ b/man/bst-workspace-open.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE OPEN" "1" "25-Mar-2018" "" "bst workspace open Manual" +.TH "BST WORKSPACE OPEN" "1" "26-Apr-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 1c3e4d53d..8d3d6817b 100644 --- a/man/bst-workspace-reset.1 +++ b/man/bst-workspace-reset.1 @@ -1,9 +1,9 @@ -.TH "BST WORKSPACE RESET" "1" "25-Mar-2018" "" "bst workspace reset Manual" +.TH "BST WORKSPACE RESET" "1" "26-Apr-2018" "" "bst workspace reset Manual" .SH NAME bst\-workspace\-reset \- Reset a workspace to its original state .SH SYNOPSIS .B bst workspace reset -[OPTIONS] ELEMENT +[OPTIONS] [ELEMENTS]... .SH DESCRIPTION Reset a workspace to its original state .SH OPTIONS @@ -11,5 +11,5 @@ Reset a workspace to its original state \fB\-\-track\fP Track and fetch the latest source before resetting .TP -\fB\-\-no\-checkout\fP -Do not checkout the source, only link to the given directory
\ No newline at end of file +\fB\-a,\fP \-\-all +Reset all open workspaces
\ No newline at end of file diff --git a/man/bst-workspace.1 b/man/bst-workspace.1 index 64b3c82f3..ad2045093 100644 --- a/man/bst-workspace.1 +++ b/man/bst-workspace.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE" "1" "25-Mar-2018" "" "bst workspace Manual" +.TH "BST WORKSPACE" "1" "26-Apr-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 -\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. .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 + 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. +\fBreset\fP + Reset a workspace to its original state + See \fBbst workspace-reset(1)\fP for full documentation on the \fBreset\fP command. @@ -1,4 +1,4 @@ -.TH "BST" "1" "25-Mar-2018" "" "bst Manual" +.TH "BST" "1" "26-Apr-2018" "" "bst Manual" .SH NAME bst \- Build and manipulate BuildStream projects... .SH SYNOPSIS @@ -12,7 +12,7 @@ user preferences configuration file. .SH OPTIONS .TP \fB\-\-version\fP -Show the version and exit. + .TP \fB\-c,\fP \-\-config PATH Configuration file to use @@ -63,9 +63,19 @@ Elements must be rebuilt when their dependencies have changed Specify a project option .SH COMMANDS .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 +\fBfetch\fP + Fetch sources in a pipeline + See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\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 \fBshow\fP @@ -73,14 +83,19 @@ Specify a project option See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command. .PP -\fBpull\fP - Pull a built artifact - See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command. +\fBworkspace\fP + Manipulate developer workspaces + See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\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 +\fBinit\fP + Initialize a new BuildStream project + See \fBbst-init(1)\fP for full documentation on the \fBinit\fP command. .PP \fBshell\fP @@ -88,26 +103,16 @@ Specify a project option See \fBbst-shell(1)\fP for full documentation on the \fBshell\fP command. .PP -\fBworkspace\fP - Manipulate developer workspaces - See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command. +\fBbuild\fP + Build elements in a pipeline + See \fBbst-build(1)\fP for full documentation on the \fBbuild\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. +\fBpull\fP + Pull a built artifact + See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command. .PP \fBpush\fP Push a built artifact See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command. - -.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. |