You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildstream.apache.org by gi...@apache.org on 2020/12/29 13:18:07 UTC
[buildstream] 07/08: Update man pages now that bst artifact delete
exists
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch jennis/introduce_artifact_delete
in repository https://gitbox.apache.org/repos/asf/buildstream.git
commit 04f75238603ace3dad94900c47b41ca453ad5160
Author: James Ennis <ja...@codethink.co.uk>
AuthorDate: Wed Mar 13 12:13:52 2019 +0000
Update man pages now that bst artifact delete exists
---
man/bst-artifact-checkout.1 | 2 +-
man/bst-artifact-delete.1 | 12 ++++++++++++
man/bst-artifact-log.1 | 2 +-
man/bst-artifact-pull.1 | 2 +-
man/bst-artifact-push.1 | 2 +-
man/bst-artifact-server.1 | 2 +-
man/bst-artifact.1 | 6 +++++-
man/bst-build.1 | 2 +-
man/bst-help.1 | 2 +-
man/bst-init.1 | 4 ++--
man/bst-shell.1 | 2 +-
man/bst-show.1 | 2 +-
man/bst-source-checkout.1 | 2 +-
man/bst-source-fetch.1 | 2 +-
man/bst-source-track.1 | 2 +-
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 | 5 ++++-
22 files changed, 41 insertions(+), 22 deletions(-)
diff --git a/man/bst-artifact-checkout.1 b/man/bst-artifact-checkout.1
index 2c11852..27b9954 100644
--- a/man/bst-artifact-checkout.1
+++ b/man/bst-artifact-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT CHECKOUT" "1" "12-Feb-2019" "" "bst artifact checkout Manual"
+.TH "BST ARTIFACT CHECKOUT" "1" "13-Mar-2019" "" "bst artifact checkout Manual"
.SH NAME
bst\-artifact\-checkout \- Checkout contents of an artifact
.SH SYNOPSIS
diff --git a/man/bst-artifact-delete.1 b/man/bst-artifact-delete.1
new file mode 100644
index 0000000..43ef9bb
--- /dev/null
+++ b/man/bst-artifact-delete.1
@@ -0,0 +1,12 @@
+.TH "BST ARTIFACT DELETE" "1" "13-Mar-2019" "" "bst artifact delete Manual"
+.SH NAME
+bst\-artifact\-delete \- Remove artifacts from the local cache
+.SH SYNOPSIS
+.B bst artifact delete
+[OPTIONS] [ARTIFACTS]...
+.SH DESCRIPTION
+Show logs of all artifacts
+.SH OPTIONS
+.TP
+\fB\-\-no\-prune\fP
+Do not prune the local cache of unreachable refs
diff --git a/man/bst-artifact-log.1 b/man/bst-artifact-log.1
index 6045e25..2be7702 100644
--- a/man/bst-artifact-log.1
+++ b/man/bst-artifact-log.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT LOG" "1" "12-Feb-2019" "" "bst artifact log Manual"
+.TH "BST ARTIFACT LOG" "1" "13-Mar-2019" "" "bst artifact log Manual"
.SH NAME
bst\-artifact\-log \- Show logs of an artifact
.SH SYNOPSIS
diff --git a/man/bst-artifact-pull.1 b/man/bst-artifact-pull.1
index b01b2bb..890090a 100644
--- a/man/bst-artifact-pull.1
+++ b/man/bst-artifact-pull.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PULL" "1" "12-Feb-2019" "" "bst artifact pull Manual"
+.TH "BST ARTIFACT PULL" "1" "13-Mar-2019" "" "bst artifact pull Manual"
.SH NAME
bst\-artifact\-pull \- Pull a built artifact
.SH SYNOPSIS
diff --git a/man/bst-artifact-push.1 b/man/bst-artifact-push.1
index bc87c82..09b0684 100644
--- a/man/bst-artifact-push.1
+++ b/man/bst-artifact-push.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PUSH" "1" "12-Feb-2019" "" "bst artifact push Manual"
+.TH "BST ARTIFACT PUSH" "1" "13-Mar-2019" "" "bst artifact push Manual"
.SH NAME
bst\-artifact\-push \- Push a built artifact
.SH SYNOPSIS
diff --git a/man/bst-artifact-server.1 b/man/bst-artifact-server.1
index f196b87..d5d9b8c 100644
--- a/man/bst-artifact-server.1
+++ b/man/bst-artifact-server.1
@@ -1,4 +1,4 @@
-.TH "BST-ARTIFACT-SERVER" "1" "12-Feb-2019" "" "bst-artifact-server Manual"
+.TH "BST-ARTIFACT-SERVER" "1" "13-Mar-2019" "" "bst-artifact-server Manual"
.SH NAME
bst-artifact-server \- CAS Artifact Server
.SH SYNOPSIS
diff --git a/man/bst-artifact.1 b/man/bst-artifact.1
index a4bbeb7..aa46e2e 100644
--- a/man/bst-artifact.1
+++ b/man/bst-artifact.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT" "1" "12-Feb-2019" "" "bst artifact Manual"
+.TH "BST ARTIFACT" "1" "13-Mar-2019" "" "bst artifact Manual"
.SH NAME
bst\-artifact \- Manipulate cached artifacts
.SH SYNOPSIS
@@ -23,3 +23,7 @@ Manipulate cached artifacts
\fBlog\fP
Show logs of an artifact
See \fBbst artifact-log(1)\fP for full documentation on the \fBlog\fP command.
+.PP
+\fBdelete\fP
+ Remove artifacts from the local cache
+ See \fBbst artifact-delete(1)\fP for full documentation on the \fBdelete\fP command.
diff --git a/man/bst-build.1 b/man/bst-build.1
index deee130..edb67a4 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "12-Feb-2019" "" "bst build Manual"
+.TH "BST BUILD" "1" "13-Mar-2019" "" "bst build Manual"
.SH NAME
bst\-build \- Build elements in a pipeline
.SH SYNOPSIS
diff --git a/man/bst-help.1 b/man/bst-help.1
index 35675db..feebf24 100644
--- a/man/bst-help.1
+++ b/man/bst-help.1
@@ -1,4 +1,4 @@
-.TH "BST HELP" "1" "12-Feb-2019" "" "bst help Manual"
+.TH "BST HELP" "1" "13-Mar-2019" "" "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 9b7b119..6f41d97 100644
--- a/man/bst-init.1
+++ b/man/bst-init.1
@@ -1,4 +1,4 @@
-.TH "BST INIT" "1" "12-Feb-2019" "" "bst init Manual"
+.TH "BST INIT" "1" "13-Mar-2019" "" "bst init Manual"
.SH NAME
bst\-init \- Initialize a new BuildStream project
.SH SYNOPSIS
@@ -18,7 +18,7 @@ interactive session.
The project name to use
.TP
\fB\-\-format\-version\fP INTEGER
-The required format version (default: 21)
+The required format version (default: 23)
.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 d223d0d..376cddb 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "12-Feb-2019" "" "bst shell Manual"
+.TH "BST SHELL" "1" "13-Mar-2019" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
diff --git a/man/bst-show.1 b/man/bst-show.1
index 4fe0b71..54d02c3 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "12-Feb-2019" "" "bst show Manual"
+.TH "BST SHOW" "1" "13-Mar-2019" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
diff --git a/man/bst-source-checkout.1 b/man/bst-source-checkout.1
index f3101b6..aed31db 100644
--- a/man/bst-source-checkout.1
+++ b/man/bst-source-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE CHECKOUT" "1" "12-Feb-2019" "" "bst source checkout Manual"
+.TH "BST SOURCE CHECKOUT" "1" "13-Mar-2019" "" "bst source checkout Manual"
.SH NAME
bst\-source\-checkout \- Checkout sources for an element
.SH SYNOPSIS
diff --git a/man/bst-source-fetch.1 b/man/bst-source-fetch.1
index 0fb63a6..ddcd557 100644
--- a/man/bst-source-fetch.1
+++ b/man/bst-source-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE FETCH" "1" "12-Feb-2019" "" "bst source fetch Manual"
+.TH "BST SOURCE FETCH" "1" "13-Mar-2019" "" "bst source fetch Manual"
.SH NAME
bst\-source\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
diff --git a/man/bst-source-track.1 b/man/bst-source-track.1
index 92f8cd3..9a24619 100644
--- a/man/bst-source-track.1
+++ b/man/bst-source-track.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE TRACK" "1" "12-Feb-2019" "" "bst source track Manual"
+.TH "BST SOURCE TRACK" "1" "13-Mar-2019" "" "bst source track Manual"
.SH NAME
bst\-source\-track \- Track new source references
.SH SYNOPSIS
diff --git a/man/bst-source.1 b/man/bst-source.1
index 8976425..4d396b3 100644
--- a/man/bst-source.1
+++ b/man/bst-source.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE" "1" "12-Feb-2019" "" "bst source Manual"
+.TH "BST SOURCE" "1" "13-Mar-2019" "" "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 5c2659f..0b43cdf 100644
--- a/man/bst-workspace-close.1
+++ b/man/bst-workspace-close.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE CLOSE" "1" "12-Feb-2019" "" "bst workspace close Manual"
+.TH "BST WORKSPACE CLOSE" "1" "13-Mar-2019" "" "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 6be37d6..f525267 100644
--- a/man/bst-workspace-list.1
+++ b/man/bst-workspace-list.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE LIST" "1" "12-Feb-2019" "" "bst workspace list Manual"
+.TH "BST WORKSPACE LIST" "1" "13-Mar-2019" "" "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 4fd70fc..4a1065d 100644
--- a/man/bst-workspace-open.1
+++ b/man/bst-workspace-open.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE OPEN" "1" "12-Feb-2019" "" "bst workspace open Manual"
+.TH "BST WORKSPACE OPEN" "1" "13-Mar-2019" "" "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 ad2fc70..d37a7f1 100644
--- a/man/bst-workspace-reset.1
+++ b/man/bst-workspace-reset.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE RESET" "1" "12-Feb-2019" "" "bst workspace reset Manual"
+.TH "BST WORKSPACE RESET" "1" "13-Mar-2019" "" "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 b90505e..3376205 100644
--- a/man/bst-workspace.1
+++ b/man/bst-workspace.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE" "1" "12-Feb-2019" "" "bst workspace Manual"
+.TH "BST WORKSPACE" "1" "13-Mar-2019" "" "bst workspace Manual"
.SH NAME
bst\-workspace \- Manipulate developer workspaces
.SH SYNOPSIS
diff --git a/man/bst.1 b/man/bst.1
index b1f6e9f..ff5e79b 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "12-Feb-2019" "" "bst Manual"
+.TH "BST" "1" "13-Mar-2019" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
@@ -67,6 +67,9 @@ 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
+.TP
+\fB\-\-cache\-buildtrees\fP [always|failure|never]
+Cache artifact build tree content on creation
.SH COMMANDS
.PP
\fBhelp\fP