summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChandan Singh <csingh43@bloomberg.net>2019-01-24 21:13:15 +0000
committerChandan Singh <chandan@chandansingh.net>2019-01-25 23:50:49 +0000
commitd74386886a1ca53a394dc80c1a29c777e087398a (patch)
tree62acfb0a853787ea2f5dcd997ca787e481c92464
parent89ba2abe538bfc5fd9fca77a71e5fb6e02f7039c (diff)
downloadbuildstream-d74386886a1ca53a394dc80c1a29c777e087398a.tar.gz
man: Refresh man pages
Notable changes: * New `source` and `artifact` command groups * Man pages corresponding to obsolete commands, that were marked as hidden in Click, have now been removed. Fixes #881.
-rw-r--r--man/bst-artifact-checkout.17
-rw-r--r--man/bst-artifact-log.14
-rw-r--r--man/bst-artifact-pull.111
-rw-r--r--man/bst-artifact-push.111
-rw-r--r--man/bst-artifact-server.14
-rw-r--r--man/bst-artifact.14
-rw-r--r--man/bst-build.111
-rw-r--r--man/bst-checkout.122
-rw-r--r--man/bst-fetch.119
-rw-r--r--man/bst-help.14
-rw-r--r--man/bst-init.16
-rw-r--r--man/bst-pull.113
-rw-r--r--man/bst-push.113
-rw-r--r--man/bst-shell.17
-rw-r--r--man/bst-show.111
-rw-r--r--man/bst-source-checkout.18
-rw-r--r--man/bst-source-fetch.111
-rw-r--r--man/bst-source-track.113
-rw-r--r--man/bst-source.14
-rw-r--r--man/bst-track.116
-rw-r--r--man/bst-workspace-close.14
-rw-r--r--man/bst-workspace-list.14
-rw-r--r--man/bst-workspace-open.14
-rw-r--r--man/bst-workspace-reset.14
-rw-r--r--man/bst-workspace.14
-rw-r--r--man/bst.116
26 files changed, 102 insertions, 133 deletions
diff --git a/man/bst-artifact-checkout.1 b/man/bst-artifact-checkout.1
index 9d1bf5534..e928a3048 100644
--- a/man/bst-artifact-checkout.1
+++ b/man/bst-artifact-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT CHECKOUT" "1" "22-Jan-2019" "" "bst artifact checkout Manual"
+.TH "BST ARTIFACT CHECKOUT" "1" "24-Jan-2019" "" "bst artifact checkout Manual"
.SH NAME
bst\-artifact\-checkout \- Checkout contents of an artifact
.SH SYNOPSIS
@@ -6,6 +6,9 @@ bst\-artifact\-checkout \- Checkout contents of an artifact
[OPTIONS] [ELEMENT]
.SH DESCRIPTION
Checkout contents of an artifact
+.PP
+When this command is executed from a workspace directory, the default
+is to checkout the artifact of the workspace element.
.SH OPTIONS
.TP
\fB\-f,\fP \-\-force
@@ -24,4 +27,4 @@ Checkout hardlinks instead of copying if possible
Create a tarball from the artifact contents instead of a file tree. If LOCATION is '-', the tarball will be dumped to the standard output.
.TP
\fB\-\-directory\fP DIRECTORY
-The directory to checkout the artifact to \ No newline at end of file
+The directory to checkout the artifact to
diff --git a/man/bst-artifact-log.1 b/man/bst-artifact-log.1
index d5911da9f..3feed0886 100644
--- a/man/bst-artifact-log.1
+++ b/man/bst-artifact-log.1
@@ -1,8 +1,8 @@
-.TH "BST ARTIFACT LOG" "1" "22-Jan-2019" "" "bst artifact log Manual"
+.TH "BST ARTIFACT LOG" "1" "24-Jan-2019" "" "bst artifact log Manual"
.SH NAME
bst\-artifact\-log \- Show logs of an artifact
.SH SYNOPSIS
.B bst artifact log
[OPTIONS] [ARTIFACTS]...
.SH DESCRIPTION
-Show logs of all artifacts \ No newline at end of file
+Show logs of all artifacts
diff --git a/man/bst-artifact-pull.1 b/man/bst-artifact-pull.1
index 5ac21ad94..81ffe2229 100644
--- a/man/bst-artifact-pull.1
+++ b/man/bst-artifact-pull.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PULL" "1" "22-Jan-2019" "" "bst artifact pull Manual"
+.TH "BST ARTIFACT PULL" "1" "24-Jan-2019" "" "bst artifact pull Manual"
.SH NAME
bst\-artifact\-pull \- Pull a built artifact
.SH SYNOPSIS
@@ -7,6 +7,13 @@ bst\-artifact\-pull \- Pull a built artifact
.SH DESCRIPTION
Pull a built artifact from the configured remote artifact cache.
.PP
+Specifying no elements will result in pulling the default targets
+of the project. If no default targets are configured, all project
+elements will be pulled.
+.PP
+When this command is executed from a workspace directory, the default
+is to pull the workspace element.
+.PP
By default the artifact will be pulled one of the configured caches
if possible, following the usual priority order. If the `--remote` flag
is given, only the specified cache will be queried.
@@ -22,4 +29,4 @@ Specify `--deps` to control which artifacts to pull:
The dependency artifacts to pull (default: none)
.TP
\fB\-r,\fP \-\-remote TEXT
-The URL of the remote cache (defaults to the first configured cache) \ No newline at end of file
+The URL of the remote cache (defaults to the first configured cache)
diff --git a/man/bst-artifact-push.1 b/man/bst-artifact-push.1
index 5ede66917..b4182023c 100644
--- a/man/bst-artifact-push.1
+++ b/man/bst-artifact-push.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PUSH" "1" "22-Jan-2019" "" "bst artifact push Manual"
+.TH "BST ARTIFACT PUSH" "1" "24-Jan-2019" "" "bst artifact push Manual"
.SH NAME
bst\-artifact\-push \- Push a built artifact
.SH SYNOPSIS
@@ -7,6 +7,13 @@ bst\-artifact\-push \- Push a built artifact
.SH DESCRIPTION
Push a built artifact to a remote artifact cache.
.PP
+Specifying no elements will result in pushing the default targets
+of the project. If no default targets are configured, all project
+elements will be pushed.
+.PP
+When this command is executed from a workspace directory, the default
+is to push the workspace element.
+.PP
The default destination is the highest priority configured cache. You can
override this by passing a different cache URL with the `--remote` flag.
.PP
@@ -25,4 +32,4 @@ Specify `--deps` to control which artifacts to push:
The dependencies to push (default: none)
.TP
\fB\-r,\fP \-\-remote TEXT
-The URL of the remote cache (defaults to the first configured cache) \ No newline at end of file
+The URL of the remote cache (defaults to the first configured cache)
diff --git a/man/bst-artifact-server.1 b/man/bst-artifact-server.1
index 1cd8a6ef5..6181b818f 100644
--- a/man/bst-artifact-server.1
+++ b/man/bst-artifact-server.1
@@ -1,4 +1,4 @@
-.TH "BST-ARTIFACT-SERVER" "1" "22-Jan-2019" "" "bst-artifact-server Manual"
+.TH "BST-ARTIFACT-SERVER" "1" "24-Jan-2019" "" "bst-artifact-server Manual"
.SH NAME
bst-artifact-server \- CAS Artifact Server
.SH SYNOPSIS
@@ -25,4 +25,4 @@ Allow clients to upload blobs and update artifact cache
Disk head room minimum in bytes
.TP
\fB\-\-head\-room\-max\fP INTEGER
-Disk head room maximum in bytes \ No newline at end of file
+Disk head room maximum in bytes
diff --git a/man/bst-artifact.1 b/man/bst-artifact.1
index b14798711..688ee3389 100644
--- a/man/bst-artifact.1
+++ b/man/bst-artifact.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT" "1" "22-Jan-2019" "" "bst artifact Manual"
+.TH "BST ARTIFACT" "1" "24-Jan-2019" "" "bst artifact Manual"
.SH NAME
bst\-artifact \- Manipulate cached artifacts
.SH SYNOPSIS
@@ -22,4 +22,4 @@ Manipulate cached artifacts
.PP
\fBlog\fP
Show logs of an artifact
- See \fBbst artifact-log(1)\fP for full documentation on the \fBlog\fP command. \ No newline at end of file
+ See \fBbst artifact-log(1)\fP for full documentation on the \fBlog\fP command.
diff --git a/man/bst-build.1 b/man/bst-build.1
index ae024c5db..5ec12f459 100644
--- a/man/bst-build.1
+++ b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "22-Jan-2019" "" "bst build Manual"
+.TH "BST BUILD" "1" "24-Jan-2019" "" "bst build Manual"
.SH NAME
bst\-build \- Build elements in a pipeline
.SH SYNOPSIS
@@ -6,6 +6,13 @@ bst\-build \- Build elements in a pipeline
[OPTIONS] [ELEMENTS]...
.SH DESCRIPTION
Build elements in a pipeline
+.PP
+Specifying no elements will result in building the default targets
+of the project. If no default targets are configured, all project
+elements will be built.
+.PP
+When this command is executed from a workspace directory, the default
+is to build the workspace element.
.SH OPTIONS
.TP
\fB\-\-all\fP
@@ -24,4 +31,4 @@ Except certain dependencies from tracking
Allow tracking to cross junction boundaries
.TP
\fB\-\-track\-save\fP
-Deprecated: This is ignored \ No newline at end of file
+Deprecated: This is ignored
diff --git a/man/bst-checkout.1 b/man/bst-checkout.1
deleted file mode 100644
index 2482f94ef..000000000
--- a/man/bst-checkout.1
+++ /dev/null
@@ -1,22 +0,0 @@
-.TH "BST CHECKOUT" "1" "22-Jan-2019" "" "bst checkout Manual"
-.SH NAME
-bst\-checkout \- Checkout a built artifact
-.SH SYNOPSIS
-.B bst checkout
-[OPTIONS] [ELEMENT] [LOCATION]
-.SH OPTIONS
-.TP
-\fB\-f,\fP \-\-force
-Allow files to be overwritten
-.TP
-\fB\-d,\fP \-\-deps [run|build|none]
-The dependencies to checkout (default: run)
-.TP
-\fB\-\-integrate\fP / \-\-no\-integrate
-Whether to run integration commands
-.TP
-\fB\-\-hardlinks\fP
-Checkout hardlinks instead of copies (handle with care)
-.TP
-\fB\-\-tar\fP
-Create a tarball from the artifact contents instead of a file tree. If LOCATION is '-', the tarball will be dumped to the standard output. \ No newline at end of file
diff --git a/man/bst-fetch.1 b/man/bst-fetch.1
deleted file mode 100644
index 12ebea8b0..000000000
--- a/man/bst-fetch.1
+++ /dev/null
@@ -1,19 +0,0 @@
-.TH "BST FETCH" "1" "22-Jan-2019" "" "bst fetch Manual"
-.SH NAME
-bst\-fetch \- Fetch sources in a pipeline
-.SH SYNOPSIS
-.B bst fetch
-[OPTIONS] [ELEMENTS]...
-.SH OPTIONS
-.TP
-\fB\-\-except\fP PATH
-Except certain dependencies from fetching
-.TP
-\fB\-d,\fP \-\-deps [none|plan|all]
-The dependencies to fetch (default: plan)
-.TP
-\fB\-\-track\fP
-Track new source references before fetching
-.TP
-\fB\-J,\fP \-\-track\-cross\-junctions
-Allow tracking to cross junction boundaries \ No newline at end of file
diff --git a/man/bst-help.1 b/man/bst-help.1
index 43f26cb0d..54bc940bb 100644
--- a/man/bst-help.1
+++ b/man/bst-help.1
@@ -1,4 +1,4 @@
-.TH "BST HELP" "1" "22-Jan-2019" "" "bst help Manual"
+.TH "BST HELP" "1" "24-Jan-2019" "" "bst help Manual"
.SH NAME
bst\-help \- Print usage information
.SH SYNOPSIS
@@ -6,4 +6,4 @@ bst\-help \- Print usage information
[OPTIONS] COMMAND
.SH DESCRIPTION
Print usage information about a given command
- \ No newline at end of file
+
diff --git a/man/bst-init.1 b/man/bst-init.1
index 561dadea5..6870acbe4 100644
--- a/man/bst-init.1
+++ b/man/bst-init.1
@@ -1,4 +1,4 @@
-.TH "BST INIT" "1" "22-Jan-2019" "" "bst init Manual"
+.TH "BST INIT" "1" "24-Jan-2019" "" "bst init Manual"
.SH NAME
bst\-init \- Initialize a new BuildStream project
.SH SYNOPSIS
@@ -18,10 +18,10 @@ interactive session.
The project name to use
.TP
\fB\-\-format\-version\fP INTEGER
-The required format version (default: 20)
+The required format version (default: 21)
.TP
\fB\-\-element\-path\fP PATH
The subdirectory to store elements in (default: elements)
.TP
\fB\-f,\fP \-\-force
-Allow overwriting an existing project.conf \ No newline at end of file
+Allow overwriting an existing project.conf
diff --git a/man/bst-pull.1 b/man/bst-pull.1
deleted file mode 100644
index 2c4c72863..000000000
--- a/man/bst-pull.1
+++ /dev/null
@@ -1,13 +0,0 @@
-.TH "BST PULL" "1" "22-Jan-2019" "" "bst pull Manual"
-.SH NAME
-bst\-pull \- Pull a built artifact
-.SH SYNOPSIS
-.B bst pull
-[OPTIONS] [ELEMENTS]...
-.SH OPTIONS
-.TP
-\fB\-d,\fP \-\-deps [none|all]
-The dependency artifacts to pull (default: none)
-.TP
-\fB\-r,\fP \-\-remote TEXT
-The URL of the remote cache (defaults to the first configured cache) \ No newline at end of file
diff --git a/man/bst-push.1 b/man/bst-push.1
deleted file mode 100644
index 2aa5144e2..000000000
--- a/man/bst-push.1
+++ /dev/null
@@ -1,13 +0,0 @@
-.TH "BST PUSH" "1" "22-Jan-2019" "" "bst push Manual"
-.SH NAME
-bst\-push \- Push a built artifact
-.SH SYNOPSIS
-.B bst push
-[OPTIONS] [ELEMENTS]...
-.SH OPTIONS
-.TP
-\fB\-d,\fP \-\-deps [none|all]
-The dependencies to push (default: none)
-.TP
-\fB\-r,\fP \-\-remote TEXT
-The URL of the remote cache (defaults to the first configured cache) \ No newline at end of file
diff --git a/man/bst-shell.1 b/man/bst-shell.1
index 5f806e453..37303c18b 100644
--- a/man/bst-shell.1
+++ b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "22-Jan-2019" "" "bst shell Manual"
+.TH "BST SHELL" "1" "24-Jan-2019" "" "bst shell Manual"
.SH NAME
bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS
@@ -7,6 +7,9 @@ bst\-shell \- Shell into an element's sandbox environment
.SH DESCRIPTION
Run a command in the target element's sandbox environment
.PP
+When this command is executed from a workspace directory, the default
+is to shell into the workspace element.
+.PP
This will stage a temporary sysroot for running the target
element, assuming it has already been built and all required
artifacts are in the local cache.
@@ -41,4 +44,4 @@ Mount a file or directory into the sandbox
Create an isolated build sandbox
.TP
\fB\-t,\fP \-\-use\-buildtree [ask|try|always|never]
-Defaults to ask but if set to always the function will fail if a build tree is not available \ No newline at end of file
+Defaults to ask but if set to always the function will fail if a build tree is not available
diff --git a/man/bst-show.1 b/man/bst-show.1
index 7804bc5f3..79d237058 100644
--- a/man/bst-show.1
+++ b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "22-Jan-2019" "" "bst show Manual"
+.TH "BST SHOW" "1" "24-Jan-2019" "" "bst show Manual"
.SH NAME
bst\-show \- Show elements in the pipeline
.SH SYNOPSIS
@@ -7,6 +7,13 @@ bst\-show \- Show elements in the pipeline
.SH DESCRIPTION
Show elements in the pipeline
.PP
+Specifying no elements will result in showing the default targets
+of the project. If no default targets are configured, all project
+elements will be shown.
+.PP
+When this command is executed from a workspace directory, the default
+is to show the workspace element.
+.PP
By default this will show all of the dependencies of the
specified target element.
.PP
@@ -62,4 +69,4 @@ The dependencies to show (default: all)
Staging or alphabetic ordering of dependencies
.TP
\fB\-f,\fP \-\-format FORMAT
-Format string for each element \ No newline at end of file
+Format string for each element
diff --git a/man/bst-source-checkout.1 b/man/bst-source-checkout.1
index 7afbc9394..cd6a0db27 100644
--- a/man/bst-source-checkout.1
+++ b/man/bst-source-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE CHECKOUT" "1" "22-Jan-2019" "" "bst source checkout Manual"
+.TH "BST SOURCE CHECKOUT" "1" "24-Jan-2019" "" "bst source checkout Manual"
.SH NAME
bst\-source\-checkout \- Checkout sources for an element
.SH SYNOPSIS
@@ -6,7 +6,9 @@ bst\-source\-checkout \- Checkout sources for an element
[OPTIONS] [ELEMENT] [LOCATION]
.SH DESCRIPTION
Checkout sources of an element to the specified location
-
+.PP
+When this command is executed from a workspace directory, the default
+is to checkout the sources of the workspace element.
.SH OPTIONS
.TP
\fB\-f,\fP \-\-force
@@ -25,4 +27,4 @@ Fetch elements if they are not fetched
Create a tarball from the element's sources instead of a file tree.
.TP
\fB\-\-include\-build\-scripts\fP
-.PP \ No newline at end of file
+.PP
diff --git a/man/bst-source-fetch.1 b/man/bst-source-fetch.1
index 6168f5f92..8cbb792e2 100644
--- a/man/bst-source-fetch.1
+++ b/man/bst-source-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE FETCH" "1" "22-Jan-2019" "" "bst source fetch Manual"
+.TH "BST SOURCE FETCH" "1" "24-Jan-2019" "" "bst source fetch Manual"
.SH NAME
bst\-source\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS
@@ -7,6 +7,13 @@ bst\-source\-fetch \- Fetch sources in a pipeline
.SH DESCRIPTION
Fetch sources required to build the pipeline
.PP
+Specifying no elements will result in fetching the default targets
+of the project. If no default targets are configured, all project
+elements will be fetched.
+.PP
+When this command is executed from a workspace directory, the default
+is to fetch the workspace element.
+.PP
By default this will only try to fetch sources which are
required for the build plan of the specified target element,
omitting sources for any elements which are already built
@@ -30,4 +37,4 @@ The dependencies to fetch (default: plan)
Track new source references before fetching
.TP
\fB\-J,\fP \-\-track\-cross\-junctions
-Allow tracking to cross junction boundaries \ No newline at end of file
+Allow tracking to cross junction boundaries
diff --git a/man/bst-source-track.1 b/man/bst-source-track.1
index 0fb3af3b5..e56233ba2 100644
--- a/man/bst-source-track.1
+++ b/man/bst-source-track.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE TRACK" "1" "22-Jan-2019" "" "bst source track Manual"
+.TH "BST SOURCE TRACK" "1" "24-Jan-2019" "" "bst source track Manual"
.SH NAME
bst\-source\-track \- Track new source references
.SH SYNOPSIS
@@ -8,6 +8,15 @@ bst\-source\-track \- Track new source references
Consults the specified tracking branches for new versions available
to build and updates the project with any newly available references.
.PP
+Specifying no elements will result in tracking the default targets
+of the project. If no default targets are configured, all project
+elements will be tracked.
+.PP
+When this command is executed from a workspace directory, the default
+is to track the workspace element.
+.PP
+If no default is declared, all elements in the project will be tracked
+.PP
By default this will track just the specified element, but you can also
update a whole tree of dependencies in one go.
.PP
@@ -25,4 +34,4 @@ Except certain dependencies from tracking
The dependencies to track (default: none)
.TP
\fB\-J,\fP \-\-cross\-junctions
-Allow crossing junction boundaries \ No newline at end of file
+Allow crossing junction boundaries
diff --git a/man/bst-source.1 b/man/bst-source.1
index 09df7510e..4344af206 100644
--- a/man/bst-source.1
+++ b/man/bst-source.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE" "1" "22-Jan-2019" "" "bst source Manual"
+.TH "BST SOURCE" "1" "24-Jan-2019" "" "bst source Manual"
.SH NAME
bst\-source \- Manipulate sources for an element
.SH SYNOPSIS
@@ -18,4 +18,4 @@ Manipulate sources for an element
.PP
\fBcheckout\fP
Checkout sources for an element
- See \fBbst source-checkout(1)\fP for full documentation on the \fBcheckout\fP command. \ No newline at end of file
+ See \fBbst source-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
diff --git a/man/bst-track.1 b/man/bst-track.1
deleted file mode 100644
index a57c0f11a..000000000
--- a/man/bst-track.1
+++ /dev/null
@@ -1,16 +0,0 @@
-.TH "BST TRACK" "1" "22-Jan-2019" "" "bst track Manual"
-.SH NAME
-bst\-track \- Track new source references
-.SH SYNOPSIS
-.B bst track
-[OPTIONS] [ELEMENTS]...
-.SH OPTIONS
-.TP
-\fB\-\-except\fP PATH
-Except certain dependencies from tracking
-.TP
-\fB\-d,\fP \-\-deps [none|all]
-The dependencies to track (default: none)
-.TP
-\fB\-J,\fP \-\-cross\-junctions
-Allow crossing junction boundaries \ No newline at end of file
diff --git a/man/bst-workspace-close.1 b/man/bst-workspace-close.1
index e8112e239..d36e5097b 100644
--- a/man/bst-workspace-close.1
+++ b/man/bst-workspace-close.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE CLOSE" "1" "22-Jan-2019" "" "bst workspace close Manual"
+.TH "BST WORKSPACE CLOSE" "1" "24-Jan-2019" "" "bst workspace close Manual"
.SH NAME
bst\-workspace\-close \- Close workspaces
.SH SYNOPSIS
@@ -12,4 +12,4 @@ Close a workspace
Remove the path that contains the closed workspace
.TP
\fB\-a,\fP \-\-all
-Close all open workspaces \ No newline at end of file
+Close all open workspaces
diff --git a/man/bst-workspace-list.1 b/man/bst-workspace-list.1
index aca6c71db..64fdb6a44 100644
--- a/man/bst-workspace-list.1
+++ b/man/bst-workspace-list.1
@@ -1,8 +1,8 @@
-.TH "BST WORKSPACE LIST" "1" "22-Jan-2019" "" "bst workspace list Manual"
+.TH "BST WORKSPACE LIST" "1" "24-Jan-2019" "" "bst workspace list Manual"
.SH NAME
bst\-workspace\-list \- List open workspaces
.SH SYNOPSIS
.B bst workspace list
[OPTIONS]
.SH DESCRIPTION
-List open workspaces \ No newline at end of file
+List open workspaces
diff --git a/man/bst-workspace-open.1 b/man/bst-workspace-open.1
index 3018443c6..e5527ba6a 100644
--- a/man/bst-workspace-open.1
+++ b/man/bst-workspace-open.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE OPEN" "1" "22-Jan-2019" "" "bst workspace open Manual"
+.TH "BST WORKSPACE OPEN" "1" "24-Jan-2019" "" "bst workspace open Manual"
.SH NAME
bst\-workspace\-open \- Open a new workspace
.SH SYNOPSIS
@@ -18,4 +18,4 @@ The workspace will be created even if the directory in which it will be created
Track and fetch new source references before checking out the workspace
.TP
\fB\-\-directory\fP DIRECTORY
-Only for use when a single Element is given: Set the directory to use to create the workspace \ No newline at end of file
+Only for use when a single Element is given: Set the directory to use to create the workspace
diff --git a/man/bst-workspace-reset.1 b/man/bst-workspace-reset.1
index df374f5eb..3bb1c73b4 100644
--- a/man/bst-workspace-reset.1
+++ b/man/bst-workspace-reset.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE RESET" "1" "22-Jan-2019" "" "bst workspace reset Manual"
+.TH "BST WORKSPACE RESET" "1" "24-Jan-2019" "" "bst workspace reset Manual"
.SH NAME
bst\-workspace\-reset \- Reset a workspace to its original state
.SH SYNOPSIS
@@ -15,4 +15,4 @@ Reset workspace state without affecting its contents
Track and fetch the latest source before resetting
.TP
\fB\-a,\fP \-\-all
-Reset all open workspaces \ No newline at end of file
+Reset all open workspaces
diff --git a/man/bst-workspace.1 b/man/bst-workspace.1
index 896cb709b..a6a0f53fc 100644
--- a/man/bst-workspace.1
+++ b/man/bst-workspace.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE" "1" "22-Jan-2019" "" "bst workspace Manual"
+.TH "BST WORKSPACE" "1" "24-Jan-2019" "" "bst workspace Manual"
.SH NAME
bst\-workspace \- Manipulate developer workspaces
.SH SYNOPSIS
@@ -22,4 +22,4 @@ Manipulate developer workspaces
.PP
\fBlist\fP
List open workspaces
- See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command. \ No newline at end of file
+ See \fBbst workspace-list(1)\fP for full documentation on the \fBlist\fP command.
diff --git a/man/bst.1 b/man/bst.1
index f6c84dee0..d019cde35 100644
--- a/man/bst.1
+++ b/man/bst.1
@@ -1,6 +1,6 @@
-.TH "BST" "1" "22-Jan-2019" "" "bst Manual"
+.TH "BST" "1" "24-Jan-2019" "" "bst Manual"
.SH NAME
-bst \- None
+bst \- Build and manipulate BuildStream projects...
.SH SYNOPSIS
.B bst
[OPTIONS] COMMAND [ARGS]...
@@ -102,21 +102,21 @@ Include an element's build tree when pulling remote element artifacts
See \fBbst-artifact(1)\fP for full documentation on the \fBartifact\fP command.
.PP
\fBfetch\fP
- Fetch sources in a pipeline
+ COMMAND OBSOLETE - Fetch sources in a pipeline
See \fBbst-fetch(1)\fP for full documentation on the \fBfetch\fP command.
.PP
\fBtrack\fP
- Track new source references
+ COMMAND OBSOLETE - Track new source references
See \fBbst-track(1)\fP for full documentation on the \fBtrack\fP command.
.PP
\fBcheckout\fP
- Checkout a built artifact
+ COMMAND OBSOLETE - Checkout a built artifact
See \fBbst-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
.PP
\fBpull\fP
- Pull a built artifact
+ COMMAND OBSOLETE - Pull a built artifact
See \fBbst-pull(1)\fP for full documentation on the \fBpull\fP command.
.PP
\fBpush\fP
- Push a built artifact
- See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command. \ No newline at end of file
+ COMMAND OBSOLETE - Push a built artifact
+ See \fBbst-push(1)\fP for full documentation on the \fBpush\fP command.