summaryrefslogtreecommitdiff
path: root/man/bst-artifact-log.1
diff options
context:
space:
mode:
authorJürg Billeter <j@bitron.ch>2019-06-27 10:48:19 +0200
committerJürg Billeter <j@bitron.ch>2019-06-27 10:48:19 +0200
commit6dd4de47567584fc4e44a6859ddd4b6e4fad3a91 (patch)
tree7fec6de89d46d9c8aa74064720f061e1cc5a6ceb /man/bst-artifact-log.1
parent868ff50c721164a9c24e076e163bed02145c4624 (diff)
downloadbuildstream-6dd4de47567584fc4e44a6859ddd4b6e4fad3a91.tar.gz
Regenerate man pages
Diffstat (limited to 'man/bst-artifact-log.1')
-rw-r--r--man/bst-artifact-log.134
1 files changed, 31 insertions, 3 deletions
diff --git a/man/bst-artifact-log.1 b/man/bst-artifact-log.1
index 2be77021f..88c797a78 100644
--- a/man/bst-artifact-log.1
+++ b/man/bst-artifact-log.1
@@ -1,8 +1,36 @@
-.TH "BST ARTIFACT LOG" "1" "13-Mar-2019" "" "bst artifact log Manual"
+.TH "BST ARTIFACT LOG" "1" "27-Jun-2019" "" "bst artifact log Manual"
.SH NAME
-bst\-artifact\-log \- Show logs of an artifact
+bst\-artifact\-log \- Show logs of artifacts
.SH SYNOPSIS
.B bst artifact log
[OPTIONS] [ARTIFACTS]...
.SH DESCRIPTION
-Show logs of all artifacts
+Show logs of artifacts.
+.PP
+Note that 'artifacts' can be element references like "hello.bst", and they
+can also be artifact references. You may use shell-style wildcards for
+either.
+.PP
+Here are some examples of element references:
+.PP
+
+- `hello.bst`
+- `*.bst`
+.PP
+Note that element references must end with '.bst' to distinguish them from
+artifact references. Anything that does not end in '.bst' is an artifact
+ref.
+.PP
+Artifact references follow the format `<project_name>/<element>/<key>`.
+Note that 'element' is without the `.bst` extension.
+.PP
+Here are some examples of artifact references:
+.PP
+
+- `myproject/hello/*`
+- `myproject/*`
+- `*`
+- `myproject/hello/827637*`
+- `myproject/he*/827637*`
+- `myproject/he??o/827637*`
+- `m*/h*/8276376b077eda104c812e6ec2f488c7c9eea211ce572c83d734c10bf241209f`