summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJürg Billeter <j@bitron.ch>2020-07-01 18:36:30 +0200
committerJürg Billeter <j@bitron.ch>2020-07-06 09:39:13 +0200
commit9c41a3c0e3fc1940f5a9015842a41dd0514e114e (patch)
tree9998e5d678f309c3d09e53eaa243193445ec890e /man
parent8745864ceea5da0ee984cce89791f452c0dadcbc (diff)
downloadbuildstream-9c41a3c0e3fc1940f5a9015842a41dd0514e114e.tar.gz
Regenerate man pages
Diffstat (limited to 'man')
-rw-r--r--man/bst-artifact-checkout.12
-rw-r--r--man/bst-artifact-delete.12
-rw-r--r--man/bst-artifact-list-contents.12
-rw-r--r--man/bst-artifact-log.12
-rw-r--r--man/bst-artifact-pull.12
-rw-r--r--man/bst-artifact-push.12
-rw-r--r--man/bst-artifact-server.12
-rw-r--r--man/bst-artifact-show.12
-rw-r--r--man/bst-artifact.12
-rw-r--r--man/bst-build.12
-rw-r--r--man/bst-help.12
-rw-r--r--man/bst-init.12
-rw-r--r--man/bst-shell.12
-rw-r--r--man/bst-show.12
-rw-r--r--man/bst-source-checkout.12
-rw-r--r--man/bst-source-fetch.12
-rw-r--r--man/bst-source-push.131
-rw-r--r--man/bst-source-track.12
-rw-r--r--man/bst-source.16
-rw-r--r--man/bst-workspace-close.12
-rw-r--r--man/bst-workspace-list.12
-rw-r--r--man/bst-workspace-open.12
-rw-r--r--man/bst-workspace-reset.12
-rw-r--r--man/bst-workspace.12
-rw-r--r--man/bst.12
25 files changed, 59 insertions, 24 deletions
diff --git a/man/bst-artifact-checkout.1 b/man/bst-artifact-checkout.1
index 51f537f69..e992c6ccd 100644
--- a/man/bst-artifact-checkout.1
+++ b/man/bst-artifact-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT CHECKOUT" "1" "2020-05-07" "" "bst artifact checkout Manual"
+.TH "BST ARTIFACT CHECKOUT" "1" "2020-07-01" "" "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
index 8b92499f8..b1dc10607 100644
--- a/man/bst-artifact-delete.1
+++ b/man/bst-artifact-delete.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT DELETE" "1" "2020-05-07" "" "bst artifact delete Manual"
+.TH "BST ARTIFACT DELETE" "1" "2020-07-01" "" "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 b53df3073..b0160d75c 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" "2020-05-07" "" "bst artifact list-contents Manual"
+.TH "BST ARTIFACT LIST-CONTENTS" "1" "2020-07-01" "" "bst artifact list-contents Manual"
.SH NAME
bst\-artifact\-list-contents \- List the contents of an artifact
.SH SYNOPSIS
diff --git a/man/bst-artifact-log.1 b/man/bst-artifact-log.1
index 84153fc38..58b3cec23 100644
--- a/man/bst-artifact-log.1
+++ b/man/bst-artifact-log.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT LOG" "1" "2020-05-07" "" "bst artifact log Manual"
+.TH "BST ARTIFACT LOG" "1" "2020-07-01" "" "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 d58346aac..15ad9e726 100644
--- a/man/bst-artifact-pull.1
+++ b/man/bst-artifact-pull.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PULL" "1" "2020-05-07" "" "bst artifact pull Manual"
+.TH "BST ARTIFACT PULL" "1" "2020-07-01" "" "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 88cf96abf..9d71aacf8 100644
--- a/man/bst-artifact-push.1
+++ b/man/bst-artifact-push.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PUSH" "1" "2020-05-07" "" "bst artifact push Manual"
+.TH "BST ARTIFACT PUSH" "1" "2020-07-01" "" "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 7d3735847..f3af6e705 100644
--- a/man/bst-artifact-server.1
+++ b/man/bst-artifact-server.1
@@ -1,4 +1,4 @@
-.TH "BST-ARTIFACT-SERVER" "1" "2020-05-07" "" "bst-artifact-server Manual"
+.TH "BST-ARTIFACT-SERVER" "1" "2020-07-01" "" "bst-artifact-server Manual"
.SH NAME
bst-artifact-server \- CAS Artifact Server
.SH SYNOPSIS
diff --git a/man/bst-artifact-show.1 b/man/bst-artifact-show.1
index 660c9dc93..cff3f4954 100644
--- a/man/bst-artifact-show.1
+++ b/man/bst-artifact-show.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT SHOW" "1" "2020-05-07" "" "bst artifact show Manual"
+.TH "BST ARTIFACT SHOW" "1" "2020-07-01" "" "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 3bdbddadb..bb1feade0 100644
--- a/man/bst-artifact.1
+++ b/man/bst-artifact.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT" "1" "2020-05-07" "" "bst artifact Manual"
+.TH "BST ARTIFACT" "1" "2020-07-01" "" "bst artifact Manual"
.SH NAME
bst\-artifact \- Manipulate cached artifacts.
.SH SYNOPSIS
diff --git a/man/bst-build.1 b/man/bst-build.1
index 34ed95e41..2842089aa 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "2020-05-07" "" "bst build Manual"
+.TH "BST BUILD" "1" "2020-07-01" "" "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 a5a72983a..459c91aeb 100644
--- a/man/bst-help.1
+++ b/man/bst-help.1
@@ -1,4 +1,4 @@
-.TH "BST HELP" "1" "2020-05-07" "" "bst help Manual"
+.TH "BST HELP" "1" "2020-07-01" "" "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 cc2735799..91dc924bb 100644
--- a/man/bst-init.1
+++ b/man/bst-init.1
@@ -1,4 +1,4 @@
-.TH "BST INIT" "1" "2020-05-07" "" "bst init Manual"
+.TH "BST INIT" "1" "2020-07-01" "" "bst init Manual"
.SH NAME
bst\-init \- Initialize a new BuildStream project
.SH SYNOPSIS
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index 33474bc75..54e694721 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "2020-05-07" "" "bst shell Manual"
+.TH "BST SHELL" "1" "2020-07-01" "" "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 d100c7c8e..a4ded7204 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "2020-05-07" "" "bst show Manual"
+.TH "BST SHOW" "1" "2020-07-01" "" "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 f843baa3c..e0a806951 100644
--- a/man/bst-source-checkout.1
+++ b/man/bst-source-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE CHECKOUT" "1" "2020-05-07" "" "bst source checkout Manual"
+.TH "BST SOURCE CHECKOUT" "1" "2020-07-01" "" "bst source checkout Manual"
.SH NAME
bst\-source\-checkout \- Checkout sources of an element
.SH SYNOPSIS
diff --git a/man/bst-source-fetch.1 b/man/bst-source-fetch.1
index 3059befb7..a0a832010 100644
--- a/man/bst-source-fetch.1
+++ b/man/bst-source-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE FETCH" "1" "2020-05-07" "" "bst source fetch Manual"
+.TH "BST SOURCE FETCH" "1" "2020-07-01" "" "bst source fetch Manual"
.SH NAME
bst\-source\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
diff --git a/man/bst-source-push.1 b/man/bst-source-push.1
new file mode 100644
index 000000000..edb2996c3
--- /dev/null
+++ b/man/bst-source-push.1
@@ -0,0 +1,31 @@
+.TH "BST SOURCE PUSH" "1" "2020-07-01" "" "bst source push Manual"
+.SH NAME
+bst\-source\-push \- Push sources in a pipeline
+.SH SYNOPSIS
+.B bst source push
+[OPTIONS] [ELEMENTS]...
+.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.
+.PP
+When this command is executed from a workspace directory, the default
+is to push the sources of the workspace element.
+.PP
+Specify `--deps` to control which sources to fetch:
+.PP
+
+ none: No dependencies, just the element itself
+ plan: Only dependencies required for the build plan
+ 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 [none|plan|build|run|all]
+The dependencies to push [default: none]
+.TP
+\fB\-r,\fP \-\-remote TEXT
+The URL of the remote source cache (defaults to the first configured cache)
diff --git a/man/bst-source-track.1 b/man/bst-source-track.1
index 6863efc45..ed5236eea 100644
--- a/man/bst-source-track.1
+++ b/man/bst-source-track.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE TRACK" "1" "2020-05-07" "" "bst source track Manual"
+.TH "BST SOURCE TRACK" "1" "2020-07-01" "" "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 adabef759..f53f26b7a 100644
--- a/man/bst-source.1
+++ b/man/bst-source.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE" "1" "2020-05-07" "" "bst source Manual"
+.TH "BST SOURCE" "1" "2020-07-01" "" "bst source Manual"
.SH NAME
bst\-source \- Manipulate sources for an element
.SH SYNOPSIS
@@ -12,6 +12,10 @@ Manipulate sources for an element
Fetch sources in a pipeline
See \fBbst source-fetch(1)\fP for full documentation on the \fBfetch\fP command.
.PP
+\fBpush\fP
+ Push sources in a pipeline
+ See \fBbst source-push(1)\fP for full documentation on the \fBpush\fP command.
+.PP
\fBtrack\fP
Track new source references
See \fBbst source-track(1)\fP for full documentation on the \fBtrack\fP command.
diff --git a/man/bst-workspace-close.1 b/man/bst-workspace-close.1
index 63e071507..b628ae4e7 100644
--- a/man/bst-workspace-close.1
+++ b/man/bst-workspace-close.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE CLOSE" "1" "2020-05-07" "" "bst workspace close Manual"
+.TH "BST WORKSPACE CLOSE" "1" "2020-07-01" "" "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 bad96bc72..8dc26eb3e 100644
--- a/man/bst-workspace-list.1
+++ b/man/bst-workspace-list.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE LIST" "1" "2020-05-07" "" "bst workspace list Manual"
+.TH "BST WORKSPACE LIST" "1" "2020-07-01" "" "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 34993b841..f1acb69d1 100644
--- a/man/bst-workspace-open.1
+++ b/man/bst-workspace-open.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE OPEN" "1" "2020-05-07" "" "bst workspace open Manual"
+.TH "BST WORKSPACE OPEN" "1" "2020-07-01" "" "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 e0e86e87a..7ea1c99e6 100644
--- a/man/bst-workspace-reset.1
+++ b/man/bst-workspace-reset.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE RESET" "1" "2020-05-07" "" "bst workspace reset Manual"
+.TH "BST WORKSPACE RESET" "1" "2020-07-01" "" "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 1f881e20b..c27133b77 100644
--- a/man/bst-workspace.1
+++ b/man/bst-workspace.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE" "1" "2020-05-07" "" "bst workspace Manual"
+.TH "BST WORKSPACE" "1" "2020-07-01" "" "bst workspace Manual"
.SH NAME
bst\-workspace \- Manipulate developer workspaces
.SH SYNOPSIS
diff --git a/man/bst.1 b/man/bst.1
index c1ca5c88c..4ea843548 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "2020-05-07" "" "bst Manual"
+.TH "BST" "1" "2020-07-01" "" "bst Manual"
.SH NAME
bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS