Merge branch 'bschubert/fix-manpages' into 'master'

types.py: Add a __str__ to PipelineSelection to fix man pages

See merge request BuildStream/buildstream!1883

25 files changed, 37 insertions, 35 deletions

diff --git a/man/bst-artifact-checkout.1 b/man/bst-artifact-checkout.1
index 8b0a6e14f..098646d35 100644
--- a/man/bst-artifact-checkout.1
+++ b/man/bst-artifact-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT CHECKOUT" "1" "31-Oct-2019" "" "bst artifact checkout Manual"
+.TH "BST ARTIFACT CHECKOUT" "1" "2020-04-23" "" "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 d3d8394b7..4e69397b6 100644
--- a/man/bst-artifact-delete.1
+++ b/man/bst-artifact-delete.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT DELETE" "1" "31-Oct-2019" "" "bst artifact delete Manual"
+.TH "BST ARTIFACT DELETE" "1" "2020-04-23" "" "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 90949af6a..bb6e8c3f6 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" "31-Oct-2019" "" "bst artifact list-contents Manual"
+.TH "BST ARTIFACT LIST-CONTENTS" "1" "2020-04-23" "" "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 e7d646602..145440b87 100644
--- a/man/bst-artifact-log.1
+++ b/man/bst-artifact-log.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT LOG" "1" "31-Oct-2019" "" "bst artifact log Manual"
+.TH "BST ARTIFACT LOG" "1" "2020-04-23" "" "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 f768ca0d7..e9b16cd72 100644
--- a/man/bst-artifact-pull.1
+++ b/man/bst-artifact-pull.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PULL" "1" "31-Oct-2019" "" "bst artifact pull Manual"
+.TH "BST ARTIFACT PULL" "1" "2020-04-23" "" "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 69280ff26..75f394d58 100644
--- a/man/bst-artifact-push.1
+++ b/man/bst-artifact-push.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PUSH" "1" "31-Oct-2019" "" "bst artifact push Manual"
+.TH "BST ARTIFACT PUSH" "1" "2020-04-23" "" "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 1f84a4924..45fc5ff39 100644
--- a/man/bst-artifact-server.1
+++ b/man/bst-artifact-server.1
@@ -1,4 +1,4 @@
-.TH "BST-ARTIFACT-SERVER" "1" "31-Oct-2019" "" "bst-artifact-server Manual"
+.TH "BST-ARTIFACT-SERVER" "1" "2020-04-23" "" "bst-artifact-server Manual"
 .SH NAME
 bst-artifact-server \- CAS Artifact Server
 .SH SYNOPSIS
@@ -26,3 +26,6 @@ Maximum disk usage in bytes  [default: 10000000000.0]
 .TP
 \fB\-\-index\-only\fP
 Only provide the BuildStream artifact and source services ("index"), not the CAS ("storage")
+.TP
+\fB\-\-log\-level\fP [warning|info|trace]
+The log level to launch with
diff --git a/man/bst-artifact-show.1 b/man/bst-artifact-show.1
index 358367b33..ee5b51bd4 100644
--- a/man/bst-artifact-show.1
+++ b/man/bst-artifact-show.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT SHOW" "1" "31-Oct-2019" "" "bst artifact show Manual"
+.TH "BST ARTIFACT SHOW" "1" "2020-04-23" "" "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 d2ac2dc02..13e21d122 100644
--- a/man/bst-artifact.1
+++ b/man/bst-artifact.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT" "1" "31-Oct-2019" "" "bst artifact Manual"
+.TH "BST ARTIFACT" "1" "2020-04-23" "" "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 ebd6eaf3e..3e9722bc1 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "31-Oct-2019" "" "bst build Manual"
+.TH "BST BUILD" "1" "2020-04-23" "" "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 92928e519..68772f6ec 100644
--- a/man/bst-help.1
+++ b/man/bst-help.1
@@ -1,4 +1,4 @@
-.TH "BST HELP" "1" "31-Oct-2019" "" "bst help Manual"
+.TH "BST HELP" "1" "2020-04-23" "" "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 a9e9d24ea..75d0f1812 100644
--- a/man/bst-init.1
+++ b/man/bst-init.1
@@ -1,4 +1,4 @@
-.TH "BST INIT" "1" "31-Oct-2019" "" "bst init Manual"
+.TH "BST INIT" "1" "2020-04-23" "" "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 d32eb613c..7acfc4616 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "31-Oct-2019" "" "bst shell Manual"
+.TH "BST SHELL" "1" "2020-04-23" "" "bst shell Manual"
 .SH NAME
 bst\-shell \- Shell into an element's sandbox environment
 .SH SYNOPSIS
@@ -44,7 +44,7 @@ Mount a file or directory into the sandbox
 Create an isolated build sandbox
 .TP
 \fB\-t,\fP \-\-use\-buildtree [ask|try|always|never]
-Use a buildtree. If `always` is set, will always fail to build if a buildtree is not available.  [default: ask]
+Stage a buildtree. If `always` is set, will always fail to build if a buildtree is not available. --pull and pull-buildtrees configuration is needed if trying to query for remotely cached buildtrees.  [default: ask]
 .TP
 \fB\-\-pull\fP
 Attempt to pull missing or incomplete artifacts
diff --git a/man/bst-show.1 b/man/bst-show.1
index 0d66f73c1..f81f73007 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "31-Oct-2019" "" "bst show Manual"
+.TH "BST SHOW" "1" "2020-04-23" "" "bst show Manual"
 .SH NAME
 bst\-show \- Show elements in the pipeline
 .SH SYNOPSIS
@@ -17,7 +17,7 @@ is to show the workspace element.
 By default this will show all of the dependencies of the
 specified target element.
 .PP
-Specify `--deps` to control which elements to show:
+Specify ``--deps`` to control which elements to show:
 .PP
 
     none:  No dependencies, just the element itself
@@ -26,17 +26,16 @@ Specify `--deps` to control which elements to show:
     build: Build time dependencies, excluding the element itself
     all:   All dependencies
 .PP
-
-FORMAT
-~~~~~~
-The --format option controls what should be printed for each element,
+**FORMAT**
+.PP
+The ``--format`` option controls what should be printed for each element,
 the following symbols can be used in the format string:
 .PP
 
     %{name}           The element name
     %{key}            The abbreviated cache key (if all sources are consistent)
     %{full-key}       The full cache key (if all sources are consistent)
-    %{state}          cached, buildable, waiting or inconsistent
+    %{state}          cached, buildable, waiting, inconsistent or junction
     %{config}         The element configuration
     %{vars}           Variable configuration
     %{env}            Environment settings
@@ -49,7 +48,7 @@ the following symbols can be used in the format string:
 .PP
 The value of the %{symbol} without the leading '%' character is understood
 as a pythonic formatting string, so python formatting features apply,
-examle:
+example:
 .PP
 
     bst show target.bst --format \
diff --git a/man/bst-source-checkout.1 b/man/bst-source-checkout.1
index 6af45c720..7596d44c1 100644
--- a/man/bst-source-checkout.1
+++ b/man/bst-source-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE CHECKOUT" "1" "31-Oct-2019" "" "bst source checkout Manual"
+.TH "BST SOURCE CHECKOUT" "1" "2020-04-23" "" "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 0b33859ed..bbffa2505 100644
--- a/man/bst-source-fetch.1
+++ b/man/bst-source-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE FETCH" "1" "20-Nov-2019" "" "bst source fetch Manual"
+.TH "BST SOURCE FETCH" "1" "2020-04-23" "" "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 12171553b..bb5a5e835 100644
--- a/man/bst-source-track.1
+++ b/man/bst-source-track.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE TRACK" "1" "31-Oct-2019" "" "bst source track Manual"
+.TH "BST SOURCE TRACK" "1" "2020-04-23" "" "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 447fb7f06..4cf43bf64 100644
--- a/man/bst-source.1
+++ b/man/bst-source.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE" "1" "31-Oct-2019" "" "bst source Manual"
+.TH "BST SOURCE" "1" "2020-04-23" "" "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 1abbe1a5a..7efde7960 100644
--- a/man/bst-workspace-close.1
+++ b/man/bst-workspace-close.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE CLOSE" "1" "31-Oct-2019" "" "bst workspace close Manual"
+.TH "BST WORKSPACE CLOSE" "1" "2020-04-23" "" "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 630efebc4..406a289d0 100644
--- a/man/bst-workspace-list.1
+++ b/man/bst-workspace-list.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE LIST" "1" "31-Oct-2019" "" "bst workspace list Manual"
+.TH "BST WORKSPACE LIST" "1" "2020-04-23" "" "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 c1b1d0bed..d94aaa5de 100644
--- a/man/bst-workspace-open.1
+++ b/man/bst-workspace-open.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE OPEN" "1" "20-Nov-2019" "" "bst workspace open Manual"
+.TH "BST WORKSPACE OPEN" "1" "2020-04-23" "" "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 a53e21729..0ae76e09f 100644
--- a/man/bst-workspace-reset.1
+++ b/man/bst-workspace-reset.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE RESET" "1" "20-Nov-2019" "" "bst workspace reset Manual"
+.TH "BST WORKSPACE RESET" "1" "2020-04-23" "" "bst workspace reset Manual"
 .SH NAME
 bst\-workspace\-reset \- Reset a workspace to its original state
 .SH SYNOPSIS
@@ -11,8 +11,5 @@ Reset a workspace to its original state
 \fB\-\-soft\fP
 Mark workspace to re-execute configuration steps (if any) on next build. Does not alter workspace contents.
 .TP
-\fB\-\-track\fP
-Track and fetch the latest source before resetting
-.TP
 \fB\-a,\fP \-\-all
 Reset all open workspaces
diff --git a/man/bst-workspace.1 b/man/bst-workspace.1
index ce5842a87..69a110f36 100644
--- a/man/bst-workspace.1
+++ b/man/bst-workspace.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE" "1" "31-Oct-2019" "" "bst workspace Manual"
+.TH "BST WORKSPACE" "1" "2020-04-23" "" "bst workspace Manual"
 .SH NAME
 bst\-workspace \- Manipulate developer workspaces
 .SH SYNOPSIS
diff --git a/man/bst.1 b/man/bst.1
index a14cac70c..711b306fa 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "31-Oct-2019" "" "bst Manual"
+.TH "BST" "1" "2020-04-23" "" "bst Manual"
 .SH NAME
 bst \- Build and manipulate BuildStream projects...
 .SH SYNOPSIS
diff --git a/src/buildstream/types.py b/src/buildstream/types.py
index 71a4dbebd..4d7a4c650 100644
--- a/src/buildstream/types.py
+++ b/src/buildstream/types.py
@@ -222,6 +222,9 @@ class _PipelineSelection(FastEnum):
     # including the targets
     RUN = "run"
 
+    def __str__(self):
+        return self.value
+
 
 ########################################
 #           Type aliases               #