This is an automated email from the ASF dual-hosted git repository. akitouni pushed a commit to branch abderrahim/2.2 in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit 25f40bc4f3ed2da9b9c2aa19a78f6a3ae6e46f7a Author: Abderrahim Kitouni <[email protected]> AuthorDate: Wed Apr 17 15:59:24 2024 +0100 Update manpages --- man/bst-artifact-checkout.1 | 7 ++-- man/bst-artifact-delete.1 | 2 +- man/bst-artifact-list-contents.1 | 7 ++-- man/bst-artifact-log.1 | 2 +- man/bst-artifact-pull.1 | 31 +++++++-------- man/bst-artifact-push.1 | 31 +++++++-------- man/bst-artifact-show.1 | 2 +- man/bst-artifact.1 | 45 +++++++++++----------- man/bst-build.1 | 27 ++++++------- man/bst-help.1 | 2 +- man/bst-init.1 | 13 ++++--- man/bst-shell.1 | 29 +++++++------- man/bst-show.1 | 83 ++++++++++++++++++++-------------------- man/bst-source-checkout.1 | 7 ++-- man/bst-source-fetch.1 | 29 +++++++------- man/bst-source-push.1 | 29 +++++++------- man/bst-source-track.1 | 29 +++++++------- man/bst-source.1 | 2 +- man/bst-workspace-close.1 | 2 +- man/bst-workspace-list.1 | 2 +- man/bst-workspace-open.1 | 2 +- man/bst-workspace-reset.1 | 2 +- man/bst-workspace.1 | 2 +- man/bst.1 | 9 +++-- 24 files changed, 205 insertions(+), 191 deletions(-) diff --git a/man/bst-artifact-checkout.1 b/man/bst-artifact-checkout.1 index 3780f28bf..8e7a66a1c 100644 --- a/man/bst-artifact-checkout.1 +++ b/man/bst-artifact-checkout.1 @@ -1,4 +1,4 @@ -.TH "BST ARTIFACT CHECKOUT" "1" "2023-07-11" "" "bst artifact checkout Manual" +.TH "BST ARTIFACT CHECKOUT" "1" "2024-04-17" "" "bst artifact checkout Manual" .SH NAME bst\-artifact\-checkout \- Checkout contents of an artifact .SH SYNOPSIS @@ -7,8 +7,9 @@ bst\-artifact\-checkout \- Checkout contents of an artifact .SH DESCRIPTION Checkout contents of an artifact .PP -When this command is executed from a workspace directory, the default -is to checkout the artifact of the workspace element. + When this command is executed from a workspace directory, the default + is to checkout the artifact of the workspace element. + .SH OPTIONS .TP \fB\-f,\fP \-\-force diff --git a/man/bst-artifact-delete.1 b/man/bst-artifact-delete.1 index 55a7bb3d3..ce2a562c4 100644 --- a/man/bst-artifact-delete.1 +++ b/man/bst-artifact-delete.1 @@ -1,4 +1,4 @@ -.TH "BST ARTIFACT DELETE" "1" "2023-07-11" "" "bst artifact delete Manual" +.TH "BST ARTIFACT DELETE" "1" "2024-04-17" "" "bst artifact delete Manual" .SH NAME bst\-artifact\-delete \- Remove artifacts from the local cache .SH SYNOPSIS diff --git a/man/bst-artifact-list-contents.1 b/man/bst-artifact-list-contents.1 index a020f3114..4dd9c80e9 100644 --- a/man/bst-artifact-list-contents.1 +++ b/man/bst-artifact-list-contents.1 @@ -1,4 +1,4 @@ -.TH "BST ARTIFACT LIST-CONTENTS" "1" "2023-07-11" "" "bst artifact list-contents Manual" +.TH "BST ARTIFACT LIST-CONTENTS" "1" "2024-04-17" "" "bst artifact list-contents Manual" .SH NAME bst\-artifact\-list-contents \- List the contents of an artifact .SH SYNOPSIS @@ -7,8 +7,9 @@ bst\-artifact\-list-contents \- List the contents of an artifact .SH DESCRIPTION List the contents of an artifact. .PP -Note that 'artifacts' can be element names, which must end in '.bst', -or artifact references, which must be in the format `<project_name>/<element>/<key>`. + Note that 'artifacts' can be element names, which must end in '.bst', + or artifact references, which must be in the format `<project_name>/<element>/<key>`. + .SH OPTIONS .TP \fB\-l,\fP \-\-long diff --git a/man/bst-artifact-log.1 b/man/bst-artifact-log.1 index f1db06a8d..1b8f237ad 100644 --- a/man/bst-artifact-log.1 +++ b/man/bst-artifact-log.1 @@ -1,4 +1,4 @@ -.TH "BST ARTIFACT LOG" "1" "2023-07-11" "" "bst artifact log Manual" +.TH "BST ARTIFACT LOG" "1" "2024-04-17" "" "bst artifact log Manual" .SH NAME bst\-artifact\-log \- Show logs of artifacts .SH SYNOPSIS diff --git a/man/bst-artifact-pull.1 b/man/bst-artifact-pull.1 index 73886278b..ad7d1edab 100644 --- a/man/bst-artifact-pull.1 +++ b/man/bst-artifact-pull.1 @@ -1,4 +1,4 @@ -.TH "BST ARTIFACT PULL" "1" "2023-07-11" "" "bst artifact pull Manual" +.TH "BST ARTIFACT PULL" "1" "2024-04-17" "" "bst artifact pull Manual" .SH NAME bst\-artifact\-pull \- Pull a built artifact .SH SYNOPSIS @@ -7,24 +7,25 @@ bst\-artifact\-pull \- Pull a built artifact .SH DESCRIPTION Pull a built artifact from the configured remote artifact cache. .PP -Specifying no elements will result in pulling the default targets -of the project. If no default targets are configured, all project -elements will be pulled. + Specifying no elements will result in pulling the default targets + of the project. If no default targets are configured, all project + elements will be pulled. .PP -When this command is executed from a workspace directory, the default -is to pull the workspace element. + When this command is executed from a workspace directory, the default + is to pull the workspace element. .PP -By default the artifact will be pulled one of the configured caches -if possible, following the usual priority order. If the `--artifact-remote` -flag is given, only the specified cache will be queried. + By default the artifact will be pulled one of the configured caches + if possible, following the usual priority order. If the `--artifact-remote` + flag is given, only the specified cache will be queried. .PP -Specify `--deps` to control which artifacts to pull: + Specify `--deps` to control which artifacts to pull: .PP - - none: No dependencies, just the element itself - run: Runtime dependencies, including the element itself - build: Build time dependencies, excluding the element itself - all: All dependencies + + none: No dependencies, just the element itself + run: Runtime dependencies, including the element itself + build: Build time dependencies, excluding the element itself + all: All dependencies + .SH OPTIONS .TP \fB\-d,\fP \-\-deps [build|none|run|all] diff --git a/man/bst-artifact-push.1 b/man/bst-artifact-push.1 index e738ea904..520f2ac99 100644 --- a/man/bst-artifact-push.1 +++ b/man/bst-artifact-push.1 @@ -1,4 +1,4 @@ -.TH "BST ARTIFACT PUSH" "1" "2023-07-11" "" "bst artifact push Manual" +.TH "BST ARTIFACT PUSH" "1" "2024-04-17" "" "bst artifact push Manual" .SH NAME bst\-artifact\-push \- Push a built artifact .SH SYNOPSIS @@ -7,24 +7,25 @@ bst\-artifact\-push \- Push a built artifact .SH DESCRIPTION Push built artifacts to a remote artifact cache, possibly pulling them first. .PP -Specifying no elements will result in pushing the default targets -of the project. If no default targets are configured, all project -elements will be pushed. + Specifying no elements will result in pushing the default targets + of the project. If no default targets are configured, all project + elements will be pushed. .PP -When this command is executed from a workspace directory, the default -is to push the workspace element. + When this command is executed from a workspace directory, the default + is to push the workspace element. .PP -If bst has been configured to include build trees on artifact pulls, -an attempt will be made to pull any required build trees to avoid the -skipping of partial artifacts being pushed. + If bst has been configured to include build trees on artifact pulls, + an attempt will be made to pull any required build trees to avoid the + skipping of partial artifacts being pushed. .PP -Specify `--deps` to control which artifacts to push: + Specify `--deps` to control which artifacts to push: .PP - - none: No dependencies, just the element itself - run: Runtime dependencies, including the element itself - build: Build time dependencies, excluding the element itself - all: All dependencies + + none: No dependencies, just the element itself + run: Runtime dependencies, including the element itself + build: Build time dependencies, excluding the element itself + all: All dependencies + .SH OPTIONS .TP \fB\-d,\fP \-\-deps [build|none|run|all] diff --git a/man/bst-artifact-show.1 b/man/bst-artifact-show.1 index fe0b2eff6..526426897 100644 --- a/man/bst-artifact-show.1 +++ b/man/bst-artifact-show.1 @@ -1,4 +1,4 @@ -.TH "BST ARTIFACT SHOW" "1" "2023-07-11" "" "bst artifact show Manual" +.TH "BST ARTIFACT SHOW" "1" "2024-04-17" "" "bst artifact show Manual" .SH NAME bst\-artifact\-show \- Show the cached state of artifacts .SH SYNOPSIS diff --git a/man/bst-artifact.1 b/man/bst-artifact.1 index 8b564852b..12ab8aa6e 100644 --- a/man/bst-artifact.1 +++ b/man/bst-artifact.1 @@ -1,4 +1,4 @@ -.TH "BST ARTIFACT" "1" "2023-07-11" "" "bst artifact Manual" +.TH "BST ARTIFACT" "1" "2024-04-17" "" "bst artifact Manual" .SH NAME bst\-artifact \- Manipulate cached artifacts. .SH SYNOPSIS @@ -7,33 +7,34 @@ bst\-artifact \- Manipulate cached artifacts. .SH DESCRIPTION Manipulate cached artifacts .PP -Some subcommands take artifact references as arguments. Artifacts -can be specified in two ways: + Some subcommands take artifact references as arguments. Artifacts + can be specified in two ways: .PP - -- artifact refs: triples of the form <project name>/<element name>/<cache key> -- element names + + - artifact refs: triples of the form <project name>/<element name>/<cache key> + - element names .PP -When elements are given, the artifact is looked up by observing the element -and it's current cache key. + When elements are given, the artifact is looked up by observing the element + and it's current cache key. .PP -The commands also support shell-style wildcard expansion: `?` matches a -single character, `*` matches zero or more characters but does not match the `/` -path separator, and `**` matches zero or more characters including `/` path separators. + The commands also support shell-style wildcard expansion: `?` matches a + single character, `*` matches zero or more characters but does not match the `/` + path separator, and `**` matches zero or more characters including `/` path separators. .PP -If the wildcard expression ends with `.bst`, then it will be used to search -element names found in the project, otherwise, it will be used to search artifacts -that are present in the local artifact cache. + If the wildcard expression ends with `.bst`, then it will be used to search + element names found in the project, otherwise, it will be used to search artifacts + that are present in the local artifact cache. .PP -Some example arguments are: + Some example arguments are: .PP - -- `myproject/hello/8276376b077eda104c812e6ec2f488c7c9eea211ce572c83d734c10bf241209f` -- `myproject/he*/827637*` -- `core/*.bst` (all elements in the core directory) -- `**.bst` (all elements) -- `myproject/**` (all artifacts from myproject) -- `myproject/myelement/*` (all cached artifacts for a specific element) + + - `myproject/hello/8276376b077eda104c812e6ec2f488c7c9eea211ce572c83d734c10bf241209f` + - `myproject/he*/827637*` + - `core/*.bst` (all elements in the core directory) + - `**.bst` (all elements) + - `myproject/**` (all artifacts from myproject) + - `myproject/myelement/*` (all cached artifacts for a specific element) + .SH COMMANDS .PP \fBshow\fP diff --git a/man/bst-build.1 b/man/bst-build.1 index bd6f45110..26c5d73bc 100644 --- a/man/bst-build.1 +++ b/man/bst-build.1 @@ -1,4 +1,4 @@ -.TH "BST BUILD" "1" "2023-07-11" "" "bst build Manual" +.TH "BST BUILD" "1" "2024-04-17" "" "bst build Manual" .SH NAME bst\-build \- Build elements in a pipeline .SH SYNOPSIS @@ -7,22 +7,23 @@ bst\-build \- Build elements in a pipeline .SH DESCRIPTION Build elements in a pipeline .PP -Specifying no elements will result in building the default targets -of the project. If no default targets are configured, all project -elements will be built. + Specifying no elements will result in building the default targets + of the project. If no default targets are configured, all project + elements will be built. .PP -When this command is executed from a workspace directory, the default -is to build the workspace element. + When this command is executed from a workspace directory, the default + is to build the workspace element. .PP -Specify `--deps` to control which dependencies must be built: + Specify `--deps` to control which dependencies must be built: .PP - - none: No dependencies, just the element itself - build: Build time dependencies, excluding the element itself - all: All dependencies + + none: No dependencies, just the element itself + build: Build time dependencies, excluding the element itself + all: All dependencies .PP -Dependencies that are consequently required to build the requested -elements will be built on demand. + Dependencies that are consequently required to build the requested + elements will be built on demand. + .SH OPTIONS .TP \fB\-d,\fP \-\-deps [none|build|all] diff --git a/man/bst-help.1 b/man/bst-help.1 index 33a7d3c68..4f5481d98 100644 --- a/man/bst-help.1 +++ b/man/bst-help.1 @@ -1,4 +1,4 @@ -.TH "BST HELP" "1" "2023-07-11" "" "bst help Manual" +.TH "BST HELP" "1" "2024-04-17" "" "bst help Manual" .SH NAME bst\-help \- Print usage information .SH SYNOPSIS diff --git a/man/bst-init.1 b/man/bst-init.1 index 2ca97715c..4ce9aef92 100644 --- a/man/bst-init.1 +++ b/man/bst-init.1 @@ -1,4 +1,4 @@ -.TH "BST INIT" "1" "2023-07-11" "" "bst init Manual" +.TH "BST INIT" "1" "2024-04-17" "" "bst init Manual" .SH NAME bst\-init \- Initialize a new BuildStream project .SH SYNOPSIS @@ -7,18 +7,19 @@ bst\-init \- Initialize a new BuildStream project .SH DESCRIPTION Initialize a new BuildStream project .PP -Creates a new BuildStream project.conf in the project -directory. + Creates a new BuildStream project.conf in the project + directory. .PP -Unless `--project-name` is specified, this will be an -interactive session. + 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\-\-min\-version\fP TEXT -The required format version [default: 2.0] +The required format version [default: 2.2] .TP \fB\-\-element\-path\fP PATH The subdirectory to store elements in [default: elements] diff --git a/man/bst-shell.1 b/man/bst-shell.1 index bdac42f8c..c11456f55 100644 --- a/man/bst-shell.1 +++ b/man/bst-shell.1 @@ -1,4 +1,4 @@ -.TH "BST SHELL" "1" "2023-07-11" "" "bst shell Manual" +.TH "BST SHELL" "1" "2024-04-17" "" "bst shell Manual" .SH NAME bst\-shell \- Shell into an element's sandbox environment .SH SYNOPSIS @@ -7,24 +7,25 @@ bst\-shell \- Shell into an element's sandbox environment .SH DESCRIPTION Run a command in the target element's sandbox environment .PP -When this command is executed from a workspace directory, the default -is to shell into the workspace element. + When this command is executed from a workspace directory, the default + is to shell into the workspace element. .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. + 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 '--' to separate a command from the options to bst, -otherwise bst may respond to them instead. e.g. + Use '--' to separate a command from the options to bst, + otherwise bst may respond to them instead. e.g. .PP - - bst shell example.bst -- df -h + + bst shell example.bst -- df -h .PP -Use the --build option to create a temporary sysroot for -building the element instead. + Use the --build option to create a temporary sysroot for + building the element instead. .PP -If no COMMAND is specified, the default is to attempt -to run an interactive shell. + If no COMMAND is specified, the default is to attempt + to run an interactive shell. + .SH OPTIONS .TP \fB\-b,\fP \-\-build diff --git a/man/bst-show.1 b/man/bst-show.1 index 734b14519..d41b2e503 100644 --- a/man/bst-show.1 +++ b/man/bst-show.1 @@ -1,4 +1,4 @@ -.TH "BST SHOW" "1" "2023-07-11" "" "bst show Manual" +.TH "BST SHOW" "1" "2024-04-17" "" "bst show Manual" .SH NAME bst\-show \- Show elements in the pipeline .SH SYNOPSIS @@ -7,57 +7,58 @@ bst\-show \- Show elements in the pipeline .SH DESCRIPTION Show elements in the pipeline .PP -Specifying no elements will result in showing the default targets -of the project. If no default targets are configured, all project -elements will be shown. + Specifying no elements will result in showing the default targets + of the project. If no default targets are configured, all project + elements will be shown. .PP -When this command is executed from a workspace directory, the default -is to show the workspace element. + When this command is executed from a workspace directory, the default + is to show the workspace element. .PP -By default this will show all of the dependencies of the -specified target element. + By default this will show all of the dependencies of the + specified target element. .PP -Specify ``--deps`` to control which elements to show: + Specify ``--deps`` to control which elements to show: .PP - - none: No dependencies, just the element itself - run: Runtime dependencies, including the element itself - build: Build time dependencies, excluding the element itself - all: All dependencies + + none: No dependencies, just the element itself + run: Runtime dependencies, including the element itself + build: Build time dependencies, excluding the element itself + all: All dependencies .PP -**FORMAT** + **FORMAT** .PP -The ``--format`` option controls what should be printed for each element, -the following symbols can be used in the format string: + 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) - %{full-key} The full cache key (if all sources are consistent) - %{state} cached, buildable, waiting, inconsistent or junction - %{config} The element configuration - %{vars} Variable configuration - %{env} Environment settings - %{public} Public domain data - %{workspaced} If the element is workspaced - %{workspace-dirs} A list of workspace directories - %{deps} A list of all dependencies - %{build-deps} A list of build dependencies - %{runtime-deps} A list of runtime dependencies + + %{name} The element name + %{key} The abbreviated cache key (if all sources are consistent) + %{full-key} The full cache key (if all sources are consistent) + %{state} cached, buildable, waiting, inconsistent or junction + %{config} The element configuration + %{vars} Variable configuration + %{env} Environment settings + %{public} Public domain data + %{workspaced} If the element is workspaced + %{workspace-dirs} A list of workspace directories + %{deps} A list of all dependencies + %{build-deps} A list of build dependencies + %{runtime-deps} A list of runtime dependencies .PP -The value of the %{symbol} without the leading '%' character is understood -as a pythonic formatting string, so python formatting features apply, -example: + The value of the %{symbol} without the leading '%' character is understood + as a pythonic formatting string, so python formatting features apply, + example: .PP - - bst show target.bst --format \ - 'Name: %{name: ^20} Key: %{key: ^8} State: %{state}' + + 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: + 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}' + + bst show target.bst --format \ + $'---------- %{name} ----------\n%{vars}' + .SH OPTIONS .TP \fB\-\-except\fP PATH diff --git a/man/bst-source-checkout.1 b/man/bst-source-checkout.1 index f1ededaaa..37e46bee8 100644 --- a/man/bst-source-checkout.1 +++ b/man/bst-source-checkout.1 @@ -1,4 +1,4 @@ -.TH "BST SOURCE CHECKOUT" "1" "2023-07-11" "" "bst source checkout Manual" +.TH "BST SOURCE CHECKOUT" "1" "2024-04-17" "" "bst source checkout Manual" .SH NAME bst\-source\-checkout \- Checkout sources of an element .SH SYNOPSIS @@ -7,8 +7,9 @@ bst\-source\-checkout \- Checkout sources of an element .SH DESCRIPTION Checkout sources of an element to the specified location .PP -When this command is executed from a workspace directory, the default -is to checkout the sources of the workspace element. + When this command is executed from a workspace directory, the default + is to checkout the sources of the workspace element. + .SH OPTIONS .TP \fB\-f,\fP \-\-force diff --git a/man/bst-source-fetch.1 b/man/bst-source-fetch.1 index 6d10b652b..e20c28ff0 100644 --- a/man/bst-source-fetch.1 +++ b/man/bst-source-fetch.1 @@ -1,4 +1,4 @@ -.TH "BST SOURCE FETCH" "1" "2023-07-11" "" "bst source fetch Manual" +.TH "BST SOURCE FETCH" "1" "2024-04-17" "" "bst source fetch Manual" .SH NAME bst\-source\-fetch \- Fetch sources in a pipeline .SH SYNOPSIS @@ -7,23 +7,24 @@ bst\-source\-fetch \- Fetch sources in a pipeline .SH DESCRIPTION Fetch sources required to build the pipeline .PP -Specifying no elements will result in fetching the default targets -of the project. If no default targets are configured, all project -elements will be fetched. + Specifying no elements will result in fetching the default targets + of the project. If no default targets are configured, all project + elements will be fetched. .PP -When this command is executed from a workspace directory, the default -is to fetch the workspace element. + When this command is executed from a workspace directory, the default + is to fetch the workspace element. .PP -By default this will only try to fetch sources for the specified -elements. + By default this will only try to fetch sources for the specified + elements. .PP -Specify `--deps` to control which sources to fetch: + Specify `--deps` to control which sources to fetch: .PP - - none: No dependencies, just the element itself - run: Runtime dependencies, including the element itself - build: Build time dependencies, excluding the element itself - all: All dependencies + + none: No dependencies, just the element itself + run: Runtime dependencies, including the element itself + build: Build time dependencies, excluding the element itself + all: All dependencies + .SH OPTIONS .TP \fB\-\-except\fP PATH diff --git a/man/bst-source-push.1 b/man/bst-source-push.1 index 61fcf47ac..dbea34404 100644 --- a/man/bst-source-push.1 +++ b/man/bst-source-push.1 @@ -1,4 +1,4 @@ -.TH "BST SOURCE PUSH" "1" "2023-07-11" "" "bst source push Manual" +.TH "BST SOURCE PUSH" "1" "2024-04-17" "" "bst source push Manual" .SH NAME bst\-source\-push \- Push sources in a pipeline .SH SYNOPSIS @@ -7,23 +7,24 @@ bst\-source\-push \- Push sources in a pipeline .SH DESCRIPTION Push sources required to build the pipeline .PP -Specifying no elements will result in pushing the sources of the default -targets of the project. If no default targets are configured, sources of -all project elements will be pushed. + Specifying no elements will result in pushing the sources of the default + targets of the project. If no default targets are configured, sources of + all project elements will be pushed. .PP -When this command is executed from a workspace directory, the default -is to push the sources of the workspace element. + When this command is executed from a workspace directory, the default + is to push the sources of the workspace element. .PP -By default this will only try to push sources for the specified -elements. + By default this will only try to push sources for the specified + elements. .PP -Specify `--deps` to control which sources to fetch: + Specify `--deps` to control which sources to fetch: .PP - - none: No dependencies, just the element itself - run: Runtime dependencies, including the element itself - build: Build time dependencies, excluding the element itself - all: All dependencies + + none: No dependencies, just the element itself + run: Runtime dependencies, including the element itself + build: Build time dependencies, excluding the element itself + all: All dependencies + .SH OPTIONS .TP \fB\-\-except\fP PATH diff --git a/man/bst-source-track.1 b/man/bst-source-track.1 index 5a482c63d..a65e78e21 100644 --- a/man/bst-source-track.1 +++ b/man/bst-source-track.1 @@ -1,4 +1,4 @@ -.TH "BST SOURCE TRACK" "1" "2023-07-11" "" "bst source track Manual" +.TH "BST SOURCE TRACK" "1" "2024-04-17" "" "bst source track Manual" .SH NAME bst\-source\-track \- Track new source references .SH SYNOPSIS @@ -6,25 +6,26 @@ bst\-source\-track \- Track new source references [OPTIONS] [ELEMENTS]... .SH DESCRIPTION Consults the specified tracking branches for new versions available -to build and updates the project with any newly available references. + to build and updates the project with any newly available references. .PP -Specifying no elements will result in tracking the default targets -of the project. If no default targets are configured, all project -elements will be tracked. + Specifying no elements will result in tracking the default targets + of the project. If no default targets are configured, all project + elements will be tracked. .PP -When this command is executed from a workspace directory, the default -is to track the workspace element. + When this command is executed from a workspace directory, the default + is to track the workspace element. .PP -If no default is declared, all elements in the project will be tracked + If no default is declared, all elements in the project will be tracked .PP -By default this will track just the specified element, but you can also -update a whole tree of dependencies in one go. + 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: + Specify `--deps` to control which sources to track: .PP - - none: No dependencies, just the specified elements - all: All dependencies of all specified elements + + none: No dependencies, just the specified elements + all: All dependencies of all specified elements + .SH OPTIONS .TP \fB\-\-except\fP PATH diff --git a/man/bst-source.1 b/man/bst-source.1 index dbbc3c0b7..e671b294f 100644 --- a/man/bst-source.1 +++ b/man/bst-source.1 @@ -1,4 +1,4 @@ -.TH "BST SOURCE" "1" "2023-07-11" "" "bst source Manual" +.TH "BST SOURCE" "1" "2024-04-17" "" "bst source Manual" .SH NAME bst\-source \- Manipulate sources for an element .SH SYNOPSIS diff --git a/man/bst-workspace-close.1 b/man/bst-workspace-close.1 index 5638ff961..b8dd18670 100644 --- a/man/bst-workspace-close.1 +++ b/man/bst-workspace-close.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE CLOSE" "1" "2023-07-11" "" "bst workspace close Manual" +.TH "BST WORKSPACE CLOSE" "1" "2024-04-17" "" "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 8f689b923..123eeb8c3 100644 --- a/man/bst-workspace-list.1 +++ b/man/bst-workspace-list.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE LIST" "1" "2023-07-11" "" "bst workspace list Manual" +.TH "BST WORKSPACE LIST" "1" "2024-04-17" "" "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 755a874cd..fa4a344ec 100644 --- a/man/bst-workspace-open.1 +++ b/man/bst-workspace-open.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE OPEN" "1" "2023-07-11" "" "bst workspace open Manual" +.TH "BST WORKSPACE OPEN" "1" "2024-04-17" "" "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 063d9dd50..0764f84f1 100644 --- a/man/bst-workspace-reset.1 +++ b/man/bst-workspace-reset.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE RESET" "1" "2023-07-11" "" "bst workspace reset Manual" +.TH "BST WORKSPACE RESET" "1" "2024-04-17" "" "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 6426acfdc..dd1195283 100644 --- a/man/bst-workspace.1 +++ b/man/bst-workspace.1 @@ -1,4 +1,4 @@ -.TH "BST WORKSPACE" "1" "2023-07-11" "" "bst workspace Manual" +.TH "BST WORKSPACE" "1" "2024-04-17" "" "bst workspace Manual" .SH NAME bst\-workspace \- Manipulate developer workspaces .SH SYNOPSIS diff --git a/man/bst.1 b/man/bst.1 index 987525ac8..b89b6729a 100644 --- a/man/bst.1 +++ b/man/bst.1 @@ -1,14 +1,15 @@ -.TH "BST" "1" "2023-07-11" "" "bst Manual" +.TH "BST" "1" "2024-04-17" "" "bst Manual" .SH NAME -bst \- Build and manipulate BuildStream projects... +bst \- Build and manipulate BuildStream projects .SH SYNOPSIS .B bst [OPTIONS] COMMAND [ARGS]... .SH DESCRIPTION Build and manipulate BuildStream projects .PP -Most of the main options override options in the -user preferences configuration file. + Most of the main options override options in the + user preferences configuration file. + .SH OPTIONS .TP \fB\-\-version\fP
