diff options
| -rw-r--r-- | man/bst-artifact-server.1 | 22 | ||||
| -rw-r--r-- | man/bst-build.1 | 2 | ||||
| -rw-r--r-- | man/bst-checkout.1 | 7 | ||||
| -rw-r--r-- | man/bst-fetch.1 | 8 | ||||
| -rw-r--r-- | man/bst-help.1 | 9 | ||||
| -rw-r--r-- | man/bst-init.1 | 8 | ||||
| -rw-r--r-- | man/bst-pull.1 | 8 | ||||
| -rw-r--r-- | man/bst-push.1 | 8 | ||||
| -rw-r--r-- | man/bst-shell.1 | 10 | ||||
| -rw-r--r-- | man/bst-show.1 | 25 | ||||
| -rw-r--r-- | man/bst-source-bundle.1 | 8 | ||||
| -rw-r--r-- | man/bst-source-checkout.1 | 19 | ||||
| -rw-r--r-- | man/bst-track.1 | 8 | ||||
| -rw-r--r-- | man/bst-workspace-close.1 | 2 | ||||
| -rw-r--r-- | man/bst-workspace-list.1 | 4 | ||||
| -rw-r--r-- | man/bst-workspace-open.1 | 11 | ||||
| -rw-r--r-- | man/bst-workspace-reset.1 | 5 | ||||
| -rw-r--r-- | man/bst-workspace.1 | 13 | ||||
| -rw-r--r-- | man/bst.1 | 86 |
19 files changed, 158 insertions, 105 deletions
diff --git a/man/bst-artifact-server.1 b/man/bst-artifact-server.1 new file mode 100644 index 000000000..c488810ab --- /dev/null +++ b/man/bst-artifact-server.1 @@ -0,0 +1,22 @@ +.TH "BST-ARTIFACT-SERVER" "1" "29-Nov-2018" "" "bst-artifact-server Manual" +.SH NAME +bst-artifact-server \- CAS Artifact Server +.SH SYNOPSIS +.B bst-artifact-server +[OPTIONS] REPO +.SH OPTIONS +.TP +\fB\-p,\fP \-\-port INTEGER +Port number [required] +.TP +\fB\-\-server\-key\fP TEXT +Private server key for TLS (PEM-encoded) +.TP +\fB\-\-server\-cert\fP TEXT +Public server certificate for TLS (PEM-encoded) +.TP +\fB\-\-client\-certs\fP TEXT +Public client certificates for TLS (PEM-encoded) +.TP +\fB\-\-enable\-push\fP +Allow clients to upload blobs and update artifact cache
\ No newline at end of file diff --git a/man/bst-build.1 b/man/bst-build.1 index 36f0b5cf6..df7b508fd 100644 --- a/man/bst-build.1 +++ b/man/bst-build.1 @@ -1,4 +1,4 @@ -.TH "BST BUILD" "1" "26-Apr-2018" "" "bst build Manual" +.TH "BST BUILD" "1" "29-Nov-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 243bdaa30..dbe7873f0 100644 --- a/man/bst-checkout.1 +++ b/man/bst-checkout.1 @@ -1,4 +1,4 @@ -.TH "BST CHECKOUT" "1" "26-Apr-2018" "" "bst checkout Manual" +.TH "BST CHECKOUT" "1" "29-Nov-2018" "" "bst checkout Manual" .SH NAME bst\-checkout \- Checkout a built artifact .SH SYNOPSIS @@ -12,7 +12,7 @@ Checkout a built artifact to the specified location \fB\-f,\fP \-\-force Allow files to be overwritten .TP -\fB\-f,\fP \-\-deps +\fB\-d,\fP \-\-deps [run|none] The dependencies to checkout (default: run) .TP \fB\-\-integrate\fP / \-\-no\-integrate @@ -22,5 +22,4 @@ Whether to run integration commands Checkout hardlinks instead of copies (handle with care) .TP \fB\-\-tar\fP -Create a tarball from the artifact contents instead of a file tree. If -LOCATION is '-', the tarball will be dumped to the standard output. +Create a tarball from the artifact contents instead of a file tree. If LOCATION is '-', the tarball will be dumped to the standard output.
\ No newline at end of file diff --git a/man/bst-fetch.1 b/man/bst-fetch.1 index ca99671c8..968193777 100644 --- a/man/bst-fetch.1 +++ b/man/bst-fetch.1 @@ -1,4 +1,4 @@ -.TH "BST FETCH" "1" "26-Apr-2018" "" "bst fetch Manual" +.TH "BST FETCH" "1" "29-Nov-2018" "" "bst fetch Manual" .SH NAME bst\-fetch \- Fetch sources in a pipeline .SH SYNOPSIS @@ -6,14 +6,14 @@ bst\-fetch \- Fetch sources in a pipeline [OPTIONS] [ELEMENTS]... .SH DESCRIPTION Fetch sources required to build the pipeline - +.PP 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. - +.PP Specify `--deps` to control which sources to fetch: - +.PP none: No dependencies, just the element itself plan: Only dependencies required for the build plan diff --git a/man/bst-help.1 b/man/bst-help.1 new file mode 100644 index 000000000..2ee9805ac --- /dev/null +++ b/man/bst-help.1 @@ -0,0 +1,9 @@ +.TH "BST HELP" "1" "29-Nov-2018" "" "bst help Manual" +.SH NAME +bst\-help \- Print usage information +.SH SYNOPSIS +.B bst help +[OPTIONS] COMMAND +.SH DESCRIPTION +Print usage information about a given command +
\ No newline at end of file diff --git a/man/bst-init.1 b/man/bst-init.1 index 0ec9abcf6..15330aa6d 100644 --- a/man/bst-init.1 +++ b/man/bst-init.1 @@ -1,4 +1,4 @@ -.TH "BST INIT" "1" "26-Apr-2018" "" "bst init Manual" +.TH "BST INIT" "1" "29-Nov-2018" "" "bst init Manual" .SH NAME bst\-init \- Initialize a new BuildStream project .SH SYNOPSIS @@ -6,10 +6,10 @@ bst\-init \- Initialize a new BuildStream project [OPTIONS] .SH DESCRIPTION Initialize a new BuildStream project - +.PP Creates a new BuildStream project.conf in the project directory. - +.PP Unless `--project-name` is specified, this will be an interactive session. .SH OPTIONS @@ -18,7 +18,7 @@ interactive session. The project name to use .TP \fB\-\-format\-version\fP INTEGER -The required format version (default: 8) +The required format version (default: 18) .TP \fB\-\-element\-path\fP PATH The subdirectory to store elements in (default: elements) diff --git a/man/bst-pull.1 b/man/bst-pull.1 index bc582e4f0..73f892e73 100644 --- a/man/bst-pull.1 +++ b/man/bst-pull.1 @@ -1,4 +1,4 @@ -.TH "BST PULL" "1" "26-Apr-2018" "" "bst pull Manual" +.TH "BST PULL" "1" "29-Nov-2018" "" "bst pull Manual" .SH NAME bst\-pull \- Pull a built artifact .SH SYNOPSIS @@ -6,13 +6,13 @@ bst\-pull \- Pull a built artifact [OPTIONS] [ELEMENTS]... .SH DESCRIPTION Pull a built artifact from the configured remote artifact cache. - +.PP By default the artifact will be pulled one of the configured caches if possible, following the usual priority order. If the `--remote` flag is given, only the specified cache will be queried. - +.PP Specify `--deps` to control which artifacts to pull: - +.PP none: No dependencies, just the element itself all: All dependencies diff --git a/man/bst-push.1 b/man/bst-push.1 index b807b9d77..2b566ddd2 100644 --- a/man/bst-push.1 +++ b/man/bst-push.1 @@ -1,4 +1,4 @@ -.TH "BST PUSH" "1" "26-Apr-2018" "" "bst push Manual" +.TH "BST PUSH" "1" "29-Nov-2018" "" "bst push Manual" .SH NAME bst\-push \- Push a built artifact .SH SYNOPSIS @@ -6,12 +6,12 @@ bst\-push \- Push a built artifact [OPTIONS] [ELEMENTS]... .SH DESCRIPTION Push a built artifact to a remote artifact cache. - +.PP The default destination is the highest priority configured cache. You can override this by passing a different cache URL with the `--remote` flag. - +.PP Specify `--deps` to control which artifacts to push: - +.PP none: No dependencies, just the element itself all: All dependencies diff --git a/man/bst-shell.1 b/man/bst-shell.1 index bc8b1164a..3cc02f973 100644 --- a/man/bst-shell.1 +++ b/man/bst-shell.1 @@ -1,4 +1,4 @@ -.TH "BST SHELL" "1" "26-Apr-2018" "" "bst shell Manual" +.TH "BST SHELL" "1" "29-Nov-2018" "" "bst shell Manual" .SH NAME bst\-shell \- Shell into an element's sandbox environment .SH SYNOPSIS @@ -6,18 +6,18 @@ bst\-shell \- Shell into an element's sandbox environment [OPTIONS] ELEMENT [COMMAND]... .SH DESCRIPTION Run a command in the target element's sandbox environment - +.PP 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. - +.PP Use the --build option to create a temporary sysroot for building the element instead. - +.PP 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. - +.PP If no COMMAND is specified, the default is to attempt to run an interactive shell. .SH OPTIONS diff --git a/man/bst-show.1 b/man/bst-show.1 index b82d0a396..74344edc8 100644 --- a/man/bst-show.1 +++ b/man/bst-show.1 @@ -1,4 +1,4 @@ -.TH "BST SHOW" "1" "26-Apr-2018" "" "bst show Manual" +.TH "BST SHOW" "1" "29-Nov-2018" "" "bst show Manual" .SH NAME bst\-show \- Show elements in the pipeline .SH SYNOPSIS @@ -6,25 +6,25 @@ bst\-show \- Show elements in the pipeline [OPTIONS] [ELEMENTS]... .SH DESCRIPTION Show elements in the pipeline - +.PP By default this will show all of the dependencies of the specified target element. - +.PP Specify `--deps` to control which elements to show: - +.PP none: No dependencies, just the element itself 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 - +.PP FORMAT ~~~~~~ The --format option controls what should be printed for each element, the following symbols can be used in the format string: - +.PP %{name} The element name %{key} The abbreviated cache key (if all sources are consistent) @@ -36,17 +36,17 @@ the following symbols can be used in the format string: %{public} Public domain data %{workspaced} If the element is workspaced %{workspace-dirs} A list of workspace directories - +.PP The value of the %{symbol} without the leading '%' character is understood as a pythonic formatting string, so python formatting features apply, examle: - +.PP bst show target.bst --format \ 'Name: %{name: ^20} Key: %{key: ^8} State: %{state}' - +.PP If you want to use a newline in a format string in bash, use the '$' modifier: - +.PP bst show target.bst --format \ $'---------- %{name} ----------\n%{vars}' @@ -62,7 +62,4 @@ The dependencies to show (default: all) Staging or alphabetic ordering of dependencies .TP \fB\-f,\fP \-\-format FORMAT -Format string for each element -.TP -\fB\-\-downloadable\fP -Refresh downloadable state
\ No newline at end of file +Format string for each element
\ No newline at end of file diff --git a/man/bst-source-bundle.1 b/man/bst-source-bundle.1 index 92580aa9e..3806c26e6 100644 --- a/man/bst-source-bundle.1 +++ b/man/bst-source-bundle.1 @@ -1,9 +1,9 @@ -.TH "BST SOURCE-BUNDLE" "1" "26-Apr-2018" "" "bst source-bundle Manual" +.TH "BST SOURCE-BUNDLE" "1" "29-Nov-2018" "" "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 +[OPTIONS] ELEMENT .SH DESCRIPTION Produce a source bundle to be manually executed @@ -16,10 +16,10 @@ Elements to except from the tarball Compress the tar file using the given algorithm. .TP \fB\-\-track\fP -Track new source references before building +Track new source references before bundling .TP \fB\-f,\fP \-\-force -Overwrite files existing in checkout directory +Overwrite an existing tarball .TP \fB\-\-directory\fP TEXT The directory to write the tarball to
\ No newline at end of file diff --git a/man/bst-source-checkout.1 b/man/bst-source-checkout.1 new file mode 100644 index 000000000..115a77afb --- /dev/null +++ b/man/bst-source-checkout.1 @@ -0,0 +1,19 @@ +.TH "BST SOURCE-CHECKOUT" "1" "29-Nov-2018" "" "bst source-checkout Manual" +.SH NAME +bst\-source-checkout \- Checkout sources for an element +.SH SYNOPSIS +.B bst source-checkout +[OPTIONS] ELEMENT LOCATION +.SH DESCRIPTION +Checkout sources of an element to the specified location + +.SH OPTIONS +.TP +\fB\-\-except\fP PATH +Except certain dependencies +.TP +\fB\-d,\fP \-\-deps [build|none|run|all] +The dependencies whose sources to checkout (default: none) +.TP +\fB\-\-fetch\fP +Fetch elements if they are not fetched
\ No newline at end of file diff --git a/man/bst-track.1 b/man/bst-track.1 index c32fc0abf..fd8530676 100644 --- a/man/bst-track.1 +++ b/man/bst-track.1 @@ -1,4 +1,4 @@ -.TH "BST TRACK" "1" "26-Apr-2018" "" "bst track Manual" +.TH "BST TRACK" "1" "29-Nov-2018" "" "bst track Manual" .SH NAME bst\-track \- Track new source references .SH SYNOPSIS @@ -7,12 +7,12 @@ bst\-track \- Track new source references .SH DESCRIPTION Consults the specified tracking branches for new versions available to build and updates the project with any newly available references. - +.PP By default this will track just the specified element, but you can also update a whole tree of dependencies in one go. - +.PP Specify `--deps` to control which sources to track: - +.PP none: No dependencies, just the specified elements all: All dependencies of all specified elements diff --git a/man/bst-workspace-close.1 b/man/bst-workspace-close.1 index c085b35ab..0858f21a3 100644 --- a/man/bst-workspace-close.1 +++ b/man/bst-workspace-close.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE CLOSE" "1" "26-Apr-2018" "" "bst workspace close Manual" +.TH "BST WORKSPACE CLOSE" "1" "29-Nov-2018" "" "bst workspace close Manual" .SH NAME bst\-workspace\-close \- Close workspaces .SH SYNOPSIS diff --git a/man/bst-workspace-list.1 b/man/bst-workspace-list.1 index f07de2419..c4fb5bf3f 100644 --- a/man/bst-workspace-list.1 +++ b/man/bst-workspace-list.1 @@ -1,8 +1,8 @@ -.TH "BST WORKSPACE LIST" "1" "26-Apr-2018" "" "bst workspace list Manual" +.TH "BST WORKSPACE LIST" "1" "29-Nov-2018" "" "bst workspace list Manual" .SH NAME bst\-workspace\-list \- List open workspaces .SH SYNOPSIS .B bst workspace list [OPTIONS] .SH DESCRIPTION -List open workspaces
\ No newline at end of file +List open workspaces diff --git a/man/bst-workspace-open.1 b/man/bst-workspace-open.1 index 926430729..319888426 100644 --- a/man/bst-workspace-open.1 +++ b/man/bst-workspace-open.1 @@ -1,9 +1,9 @@ -.TH "BST WORKSPACE OPEN" "1" "26-Apr-2018" "" "bst workspace open Manual" +.TH "BST WORKSPACE OPEN" "1" "29-Nov-2018" "" "bst workspace open Manual" .SH NAME bst\-workspace\-open \- Open a new workspace .SH SYNOPSIS .B bst workspace open -[OPTIONS] ELEMENT DIRECTORY +[OPTIONS] ELEMENTS... .SH DESCRIPTION Open a workspace for manual source modification .SH OPTIONS @@ -12,7 +12,10 @@ Open a workspace for manual source modification Do not checkout the source, only link to the given directory .TP \fB\-f,\fP \-\-force -Overwrite files existing in checkout directory +The workspace will be created even if the directory in which it will be created is not empty or if a workspace for that element already exists .TP \fB\-\-track\fP -Track and fetch new source references before checking out the workspace
\ No newline at end of file +Track and fetch new source references before checking out the workspace +.TP +\fB\-\-directory\fP DIRECTORY +Only for use when a single Element is given: Set the directory to use to create the workspace
\ No newline at end of file diff --git a/man/bst-workspace-reset.1 b/man/bst-workspace-reset.1 index 8d3d6817b..8f5ca0e4a 100644 --- a/man/bst-workspace-reset.1 +++ b/man/bst-workspace-reset.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE RESET" "1" "26-Apr-2018" "" "bst workspace reset Manual" +.TH "BST WORKSPACE RESET" "1" "29-Nov-2018" "" "bst workspace reset Manual" .SH NAME bst\-workspace\-reset \- Reset a workspace to its original state .SH SYNOPSIS @@ -8,6 +8,9 @@ bst\-workspace\-reset \- Reset a workspace to its original state Reset a workspace to its original state .SH OPTIONS .TP +\fB\-\-soft\fP +Reset workspace state without affecting its contents +.TP \fB\-\-track\fP Track and fetch the latest source before resetting .TP diff --git a/man/bst-workspace.1 b/man/bst-workspace.1 index ad2045093..2b4881cfc 100644 --- a/man/bst-workspace.1 +++ b/man/bst-workspace.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE" "1" "26-Apr-2018" "" "bst workspace Manual" +.TH "BST WORKSPACE" "1" "29-Nov-2018" "" "bst workspace Manual" .SH NAME bst\-workspace \- Manipulate developer workspaces .SH SYNOPSIS @@ -11,18 +11,15 @@ Manipulate developer workspaces \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 workspaces 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 +\fBlist\fP + List open workspaces + See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command.
\ No newline at end of file @@ -1,4 +1,4 @@ -.TH "BST" "1" "26-Apr-2018" "" "bst Manual" +.TH "BST" "1" "29-Nov-2018" "" "bst Manual" .SH NAME bst \- Build and manipulate BuildStream projects... .SH SYNOPSIS @@ -6,15 +6,15 @@ bst \- Build and manipulate BuildStream projects... [OPTIONS] COMMAND [ARGS]... .SH DESCRIPTION Build and manipulate BuildStream projects - +.PP Most of the main options override options in the user preferences configuration file. .SH OPTIONS .TP \fB\-\-version\fP - +.PP .TP -\fB\-c,\fP \-\-config PATH +\fB\-c,\fP \-\-config FILE Configuration file to use .TP \fB\-C,\fP \-\-directory DIRECTORY @@ -61,58 +61,62 @@ Elements must be rebuilt when their dependencies have changed .TP \fB\-o,\fP \-\-option OPTION VALUE Specify a project option +.TP +\fB\-\-default\-mirror\fP TEXT +The mirror to fetch from first, before attempting other mirrors +.TP +\fB\-\-pull\-buildtrees\fP +Include an element's build tree when pulling remote element artifacts .SH COMMANDS .PP -\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 - Show elements in the pipeline - See \fBbst-show(1)\fP for full documentation on the \fBshow\fP command. - -.PP -\fBworkspace\fP - Manipulate developer workspaces - See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\fP command. - -.PP -\fBtrack\fP - Track new source references - See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command. - +\fBhelp\fP + Print usage information + See \fBbst-help(1)\fP for full documentation on the \fBhelp\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 - 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 +\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 \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 +\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 +\fBcheckout\fP + Checkout a built artifact + See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command. +.PP +\fBsource-checkout\fP + Checkout sources for an element + See \fBbst-source-checkout(1)\fP for full documentation on the \fBsource-checkout\fP command. +.PP +\fBworkspace\fP + Manipulate developer workspaces + See \fBbst-workspace(1)\fP for full documentation on the \fBworkspace\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.
\ No newline at end of file |