Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions man/bst-artifact-checkout.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST ARTIFACT CHECKOUT" "1" "2025-04-24" "2.5" "bst artifact checkout Manual"
.TH "BST ARTIFACT CHECKOUT" "1" "2025-05-09" "2.5" "bst artifact checkout Manual"
.SH NAME
bst\-artifact\-checkout \- Checkout contents of an artifact
.SH SYNOPSIS
Expand All @@ -7,9 +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.
.PP
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
Expand Down
2 changes: 1 addition & 1 deletion man/bst-artifact-delete.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST ARTIFACT DELETE" "1" "2025-04-24" "2.5" "bst artifact delete Manual"
.TH "BST ARTIFACT DELETE" "1" "2025-05-09" "2.5" "bst artifact delete Manual"
.SH NAME
bst\-artifact\-delete \- Remove artifacts from the local cache
.SH SYNOPSIS
Expand Down
8 changes: 4 additions & 4 deletions man/bst-artifact-list-contents.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST ARTIFACT LIST-CONTENTS" "1" "2025-04-24" "2.5" "bst artifact list-contents Manual"
.TH "BST ARTIFACT LIST-CONTENTS" "1" "2025-05-09" "2.5" "bst artifact list-contents Manual"
.SH NAME
bst\-artifact\-list-contents \- List the contents of an artifact
.SH SYNOPSIS
Expand All @@ -7,9 +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>`.
.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>`.
.SH OPTIONS
.TP
\fB\-l,\fP \-\-long
Expand Down
2 changes: 1 addition & 1 deletion man/bst-artifact-log.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST ARTIFACT LOG" "1" "2025-04-24" "2.5" "bst artifact log Manual"
.TH "BST ARTIFACT LOG" "1" "2025-05-09" "2.5" "bst artifact log Manual"
.SH NAME
bst\-artifact\-log \- Show logs of artifacts
.SH SYNOPSIS
Expand Down
32 changes: 16 additions & 16 deletions man/bst-artifact-pull.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST ARTIFACT PULL" "1" "2025-04-24" "2.5" "bst artifact pull Manual"
.TH "BST ARTIFACT PULL" "1" "2025-05-09" "2.5" "bst artifact pull Manual"
.SH NAME
bst\-artifact\-pull \- Pull a built artifact
.SH SYNOPSIS
Expand All @@ -7,25 +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:
.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
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

.SH OPTIONS
.TP
\fB\-d,\fP \-\-deps [build|none|run|all]
Expand Down
32 changes: 16 additions & 16 deletions man/bst-artifact-push.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST ARTIFACT PUSH" "1" "2025-04-24" "2.5" "bst artifact push Manual"
.TH "BST ARTIFACT PUSH" "1" "2025-05-09" "2.5" "bst artifact push Manual"
.SH NAME
bst\-artifact\-push \- Push a built artifact
.SH SYNOPSIS
Expand All @@ -7,25 +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:
.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
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

.SH OPTIONS
.TP
\fB\-d,\fP \-\-deps [build|none|run|all]
Expand Down
2 changes: 1 addition & 1 deletion man/bst-artifact-show.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST ARTIFACT SHOW" "1" "2025-04-24" "2.5" "bst artifact show Manual"
.TH "BST ARTIFACT SHOW" "1" "2025-05-09" "2.5" "bst artifact show Manual"
.SH NAME
bst\-artifact\-show \- Show the cached state of artifacts
.SH SYNOPSIS
Expand Down
46 changes: 23 additions & 23 deletions man/bst-artifact.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST ARTIFACT" "1" "2025-04-24" "2.5" "bst artifact Manual"
.TH "BST ARTIFACT" "1" "2025-05-09" "2.5" "bst artifact Manual"
.SH NAME
bst\-artifact \- Manipulate cached artifacts.
.SH SYNOPSIS
Expand All @@ -7,34 +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:
.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)
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)

.SH COMMANDS
.PP
\fBshow\fP
Expand Down
28 changes: 14 additions & 14 deletions man/bst-build.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST BUILD" "1" "2025-04-24" "2.5" "bst build Manual"
.TH "BST BUILD" "1" "2025-05-09" "2.5" "bst build Manual"
.SH NAME
bst\-build \- Build elements in a pipeline
.SH SYNOPSIS
Expand All @@ -7,23 +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
.PP
Dependencies that are consequently required to build the requested
elements will be built on demand.

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.

.SH OPTIONS
.TP
\fB\-d,\fP \-\-deps [none|build|all]
Expand Down
2 changes: 1 addition & 1 deletion man/bst-help.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST HELP" "1" "2025-04-24" "2.5" "bst help Manual"
.TH "BST HELP" "1" "2025-05-09" "2.5" "bst help Manual"
.SH NAME
bst\-help \- Print usage information
.SH SYNOPSIS
Expand Down
12 changes: 6 additions & 6 deletions man/bst-init.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST INIT" "1" "2025-04-24" "2.5" "bst init Manual"
.TH "BST INIT" "1" "2025-05-09" "2.5" "bst init Manual"
.SH NAME
bst\-init \- Initialize a new BuildStream project
.SH SYNOPSIS
Expand All @@ -7,12 +7,12 @@ 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.
.PP
Unless `--project-name` is specified, this will be an
interactive session.
Creates a new BuildStream project.conf in the project
directory.
.PP
Unless `--project-name` is specified, this will be an
interactive session.

.SH OPTIONS
.TP
\fB\-\-project\-name\fP TEXT
Expand Down
30 changes: 15 additions & 15 deletions man/bst-shell.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "BST SHELL" "1" "2025-04-24" "2.5" "bst shell Manual"
.TH "BST SHELL" "1" "2025-05-09" "2.5" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
Expand All @@ -7,25 +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.
.PP
If no COMMAND is specified, the default is to attempt
to run an interactive shell.
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.

.SH OPTIONS
.TP
\fB\-b,\fP \-\-build
Expand Down
Loading
Loading