Skip to content

Commit 073dc0a

Browse files
tristanvbtristanvb
committed
man: Updated man pages because of changed bst show interface.
1 parent 3490f16 commit 073dc0a

24 files changed

+206
-205
lines changed

‎man/bst-artifact-checkout.1‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST ARTIFACT CHECKOUT" "1" "2024-08-08" "" "bst artifact checkout Manual"
1+
.TH "BST ARTIFACT CHECKOUT" "1" "2025-04-24" "2.5" "bst artifact checkout Manual"
22
.SH NAME
33
bst\-artifact\-checkout \- Checkout contents of an artifact
44
.SH SYNOPSIS
@@ -7,9 +7,9 @@ bst\-artifact\-checkout \- Checkout contents of an artifact
77
.SH DESCRIPTION
88
Checkout contents of an artifact
99
.PP
10-
When this command is executed from a workspace directory, the default
11-
is to checkout the artifact of the workspace element.
12-
10+
When this command is executed from a workspace directory, the default
11+
is to checkout the artifact of the workspace element.
12+
.PP
1313
.SH OPTIONS
1414
.TP
1515
\fB\-f,\fP \-\-force

‎man/bst-artifact-delete.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST ARTIFACT DELETE" "1" "2024-08-08" "" "bst artifact delete Manual"
1+
.TH "BST ARTIFACT DELETE" "1" "2025-04-24" "2.5" "bst artifact delete Manual"
22
.SH NAME
33
bst\-artifact\-delete \- Remove artifacts from the local cache
44
.SH SYNOPSIS

‎man/bst-artifact-list-contents.1‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST ARTIFACT LIST-CONTENTS" "1" "2024-08-08" "" "bst artifact list-contents Manual"
1+
.TH "BST ARTIFACT LIST-CONTENTS" "1" "2025-04-24" "2.5" "bst artifact list-contents Manual"
22
.SH NAME
33
bst\-artifact\-list-contents \- List the contents of an artifact
44
.SH SYNOPSIS
@@ -7,9 +7,9 @@ bst\-artifact\-list-contents \- List the contents of an artifact
77
.SH DESCRIPTION
88
List the contents of an artifact.
99
.PP
10-
Note that 'artifacts' can be element names, which must end in '.bst',
11-
or artifact references, which must be in the format `<project_name>/<element>/<key>`.
12-
10+
Note that 'artifacts' can be element names, which must end in '.bst',
11+
or artifact references, which must be in the format `<project_name>/<element>/<key>`.
12+
.PP
1313
.SH OPTIONS
1414
.TP
1515
\fB\-l,\fP \-\-long

‎man/bst-artifact-log.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST ARTIFACT LOG" "1" "2024-08-08" "" "bst artifact log Manual"
1+
.TH "BST ARTIFACT LOG" "1" "2025-04-24" "2.5" "bst artifact log Manual"
22
.SH NAME
33
bst\-artifact\-log \- Show logs of artifacts
44
.SH SYNOPSIS

‎man/bst-artifact-pull.1‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST ARTIFACT PULL" "1" "2024-08-08" "" "bst artifact pull Manual"
1+
.TH "BST ARTIFACT PULL" "1" "2025-04-24" "2.5" "bst artifact pull Manual"
22
.SH NAME
33
bst\-artifact\-pull \- Pull a built artifact
44
.SH SYNOPSIS
@@ -7,25 +7,25 @@ bst\-artifact\-pull \- Pull a built artifact
77
.SH DESCRIPTION
88
Pull a built artifact from the configured remote artifact cache.
99
.PP
10-
Specifying no elements will result in pulling the default targets
11-
of the project. If no default targets are configured, all project
12-
elements will be pulled.
10+
Specifying no elements will result in pulling the default targets
11+
of the project. If no default targets are configured, all project
12+
elements will be pulled.
1313
.PP
14-
When this command is executed from a workspace directory, the default
15-
is to pull the workspace element.
14+
When this command is executed from a workspace directory, the default
15+
is to pull the workspace element.
1616
.PP
17-
By default the artifact will be pulled one of the configured caches
18-
if possible, following the usual priority order. If the `--artifact-remote`
19-
flag is given, only the specified cache will be queried.
17+
By default the artifact will be pulled one of the configured caches
18+
if possible, following the usual priority order. If the `--artifact-remote`
19+
flag is given, only the specified cache will be queried.
2020
.PP
21-
Specify `--deps` to control which artifacts to pull:
21+
Specify `--deps` to control which artifacts to pull:
22+
.PP
23+

24+
none: No dependencies, just the element itself
25+
run: Runtime dependencies, including the element itself
26+
build: Build time dependencies, excluding the element itself
27+
all: All dependencies
2228
.PP
23-

24-
none: No dependencies, just the element itself
25-
run: Runtime dependencies, including the element itself
26-
build: Build time dependencies, excluding the element itself
27-
all: All dependencies
28-
2929
.SH OPTIONS
3030
.TP
3131
\fB\-d,\fP \-\-deps [build|none|run|all]

‎man/bst-artifact-push.1‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST ARTIFACT PUSH" "1" "2024-08-08" "" "bst artifact push Manual"
1+
.TH "BST ARTIFACT PUSH" "1" "2025-04-24" "2.5" "bst artifact push Manual"
22
.SH NAME
33
bst\-artifact\-push \- Push a built artifact
44
.SH SYNOPSIS
@@ -7,25 +7,25 @@ bst\-artifact\-push \- Push a built artifact
77
.SH DESCRIPTION
88
Push built artifacts to a remote artifact cache, possibly pulling them first.
99
.PP
10-
Specifying no elements will result in pushing the default targets
11-
of the project. If no default targets are configured, all project
12-
elements will be pushed.
10+
Specifying no elements will result in pushing the default targets
11+
of the project. If no default targets are configured, all project
12+
elements will be pushed.
1313
.PP
14-
When this command is executed from a workspace directory, the default
15-
is to push the workspace element.
14+
When this command is executed from a workspace directory, the default
15+
is to push the workspace element.
1616
.PP
17-
If bst has been configured to include build trees on artifact pulls,
18-
an attempt will be made to pull any required build trees to avoid the
19-
skipping of partial artifacts being pushed.
17+
If bst has been configured to include build trees on artifact pulls,
18+
an attempt will be made to pull any required build trees to avoid the
19+
skipping of partial artifacts being pushed.
2020
.PP
21-
Specify `--deps` to control which artifacts to push:
21+
Specify `--deps` to control which artifacts to push:
22+
.PP
23+

24+
none: No dependencies, just the element itself
25+
run: Runtime dependencies, including the element itself
26+
build: Build time dependencies, excluding the element itself
27+
all: All dependencies
2228
.PP
23-

24-
none: No dependencies, just the element itself
25-
run: Runtime dependencies, including the element itself
26-
build: Build time dependencies, excluding the element itself
27-
all: All dependencies
28-
2929
.SH OPTIONS
3030
.TP
3131
\fB\-d,\fP \-\-deps [build|none|run|all]

‎man/bst-artifact-show.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST ARTIFACT SHOW" "1" "2024-08-08" "" "bst artifact show Manual"
1+
.TH "BST ARTIFACT SHOW" "1" "2025-04-24" "2.5" "bst artifact show Manual"
22
.SH NAME
33
bst\-artifact\-show \- Show the cached state of artifacts
44
.SH SYNOPSIS

‎man/bst-artifact.1‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST ARTIFACT" "1" "2024-08-08" "" "bst artifact Manual"
1+
.TH "BST ARTIFACT" "1" "2025-04-24" "2.5" "bst artifact Manual"
22
.SH NAME
33
bst\-artifact \- Manipulate cached artifacts.
44
.SH SYNOPSIS
@@ -7,34 +7,34 @@ bst\-artifact \- Manipulate cached artifacts.
77
.SH DESCRIPTION
88
Manipulate cached artifacts
99
.PP
10-
Some subcommands take artifact references as arguments. Artifacts
11-
can be specified in two ways:
10+
Some subcommands take artifact references as arguments. Artifacts
11+
can be specified in two ways:
1212
.PP
13-
14-
- artifact refs: triples of the form <project name>/<element name>/<cache key>
15-
- element names
13+
14+
- artifact refs: triples of the form <project name>/<element name>/<cache key>
15+
- element names
1616
.PP
17-
When elements are given, the artifact is looked up by observing the element
18-
and it's current cache key.
17+
When elements are given, the artifact is looked up by observing the element
18+
and it's current cache key.
1919
.PP
20-
The commands also support shell-style wildcard expansion: `?` matches a
21-
single character, `*` matches zero or more characters but does not match the `/`
22-
path separator, and `**` matches zero or more characters including `/` path separators.
20+
The commands also support shell-style wildcard expansion: `?` matches a
21+
single character, `*` matches zero or more characters but does not match the `/`
22+
path separator, and `**` matches zero or more characters including `/` path separators.
2323
.PP
24-
If the wildcard expression ends with `.bst`, then it will be used to search
25-
element names found in the project, otherwise, it will be used to search artifacts
26-
that are present in the local artifact cache.
24+
If the wildcard expression ends with `.bst`, then it will be used to search
25+
element names found in the project, otherwise, it will be used to search artifacts
26+
that are present in the local artifact cache.
2727
.PP
28-
Some example arguments are:
28+
Some example arguments are:
29+
.PP
30+

31+
- `myproject/hello/8276376b077eda104c812e6ec2f488c7c9eea211ce572c83d734c10bf241209f`
32+
- `myproject/he*/827637*`
33+
- `core/*.bst` (all elements in the core directory)
34+
- `**.bst` (all elements)
35+
- `myproject/**` (all artifacts from myproject)
36+
- `myproject/myelement/*` (all cached artifacts for a specific element)
2937
.PP
30-

31-
- `myproject/hello/8276376b077eda104c812e6ec2f488c7c9eea211ce572c83d734c10bf241209f`
32-
- `myproject/he*/827637*`
33-
- `core/*.bst` (all elements in the core directory)
34-
- `**.bst` (all elements)
35-
- `myproject/**` (all artifacts from myproject)
36-
- `myproject/myelement/*` (all cached artifacts for a specific element)
37-
3838
.SH COMMANDS
3939
.PP
4040
\fBshow\fP

‎man/bst-build.1‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST BUILD" "1" "2024-08-08" "" "bst build Manual"
1+
.TH "BST BUILD" "1" "2025-04-24" "2.5" "bst build Manual"
22
.SH NAME
33
bst\-build \- Build elements in a pipeline
44
.SH SYNOPSIS
@@ -7,23 +7,23 @@ bst\-build \- Build elements in a pipeline
77
.SH DESCRIPTION
88
Build elements in a pipeline
99
.PP
10-
Specifying no elements will result in building the default targets
11-
of the project. If no default targets are configured, all project
12-
elements will be built.
10+
Specifying no elements will result in building the default targets
11+
of the project. If no default targets are configured, all project
12+
elements will be built.
1313
.PP
14-
When this command is executed from a workspace directory, the default
15-
is to build the workspace element.
14+
When this command is executed from a workspace directory, the default
15+
is to build the workspace element.
1616
.PP
17-
Specify `--deps` to control which dependencies must be built:
17+
Specify `--deps` to control which dependencies must be built:
1818
.PP
19-

20-
none: No dependencies, just the element itself
21-
build: Build time dependencies, excluding the element itself
22-
all: All dependencies
19+

20+
none: No dependencies, just the element itself
21+
build: Build time dependencies, excluding the element itself
22+
all: All dependencies
23+
.PP
24+
Dependencies that are consequently required to build the requested
25+
elements will be built on demand.
2326
.PP
24-
Dependencies that are consequently required to build the requested
25-
elements will be built on demand.
26-
2727
.SH OPTIONS
2828
.TP
2929
\fB\-d,\fP \-\-deps [none|build|all]

‎man/bst-help.1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH "BST HELP" "1" "2024-08-08" "" "bst help Manual"
1+
.TH "BST HELP" "1" "2025-04-24" "2.5" "bst help Manual"
22
.SH NAME
33
bst\-help \- Print usage information
44
.SH SYNOPSIS

0 commit comments

Comments
 (0)