Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • willsalmon/buildstream
  • CumHoleZH/buildstream
  • tchaik/buildstream
  • DCotyPortfolio/buildstream
  • jesusoctavioas/buildstream
  • patrickmmartin/buildstream
  • franred/buildstream
  • tintou/buildstream
  • alatiera/buildstream
  • martinblanchard/buildstream
  • neverdie22042524/buildstream
  • Mattlk13/buildstream
  • PServers/buildstream
  • phamnghia610909/buildstream
  • chiaratolentino/buildstream
  • eysz7-x-x/buildstream
  • kerrick1/buildstream
  • matthew-yates/buildstream
  • twofeathers/buildstream
  • mhadjimichael/buildstream
  • pointswaves/buildstream
  • Mr.JackWilson/buildstream
  • Tw3akG33k/buildstream
  • AlexFazakas/buildstream
  • eruidfkiy/buildstream
  • clamotion2/buildstream
  • nanonyme/buildstream
  • wickyjaaa/buildstream
  • nmanchev/buildstream
  • bojorquez.ja/buildstream
  • mostynb/buildstream
  • highpit74/buildstream
  • Demo112/buildstream
  • ba2014sheer/buildstream
  • tonimadrino/buildstream
  • usuario2o/buildstream
  • Angelika123456/buildstream
  • neo355/buildstream
  • corentin-ferlay/buildstream
  • coldtom/buildstream
  • wifitvbox81/buildstream
  • 358253885/buildstream
  • seanborg/buildstream
  • SotK/buildstream
  • DouglasWinship/buildstream
  • karansthr97/buildstream
  • louib/buildstream
  • bwh-ct/buildstream
  • robjh/buildstream
  • we88c0de/buildstream
  • zhengxian5555/buildstream
51 results
Show changes
Commits on Source (5)
Showing with 86 additions and 106 deletions
...@@ -1259,14 +1259,9 @@ into the ``setup.py``, as such, whenever the frontend command line ...@@ -1259,14 +1259,9 @@ into the ``setup.py``, as such, whenever the frontend command line
interface changes, the static man pages should be regenerated and interface changes, the static man pages should be regenerated and
committed with that. committed with that.
To do this, first ensure you have ``click_man`` installed, possibly To do this, run the following from the the toplevel directory of BuildStream::
with::
pip3 install --user click_man tox -e man
Then, in the toplevel directory of buildstream, run the following::
python3 setup.py --command-packages=click_man.commands man_pages
And commit the result, ensuring that you have added anything in And commit the result, ensuring that you have added anything in
the ``man/`` subdirectory, which will be automatically included the ``man/`` subdirectory, which will be automatically included
......
.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 .SH NAME
bst\-artifact\-checkout \- Checkout contents of an artifact bst\-artifact\-checkout \- Checkout contents of an artifact
.SH SYNOPSIS .SH SYNOPSIS
...@@ -6,6 +6,9 @@ bst\-artifact\-checkout \- Checkout contents of an artifact ...@@ -6,6 +6,9 @@ bst\-artifact\-checkout \- Checkout contents of an artifact
[OPTIONS] [ELEMENT] [OPTIONS] [ELEMENT]
.SH DESCRIPTION .SH DESCRIPTION
Checkout contents of an artifact 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 .SH OPTIONS
.TP .TP
\fB\-f,\fP \-\-force \fB\-f,\fP \-\-force
...@@ -24,4 +27,4 @@ Checkout hardlinks instead of copying if possible ...@@ -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. 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 .TP
\fB\-\-directory\fP DIRECTORY \fB\-\-directory\fP DIRECTORY
The directory to checkout the artifact to The directory to checkout the artifact to
\ No newline at end of file
.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 .SH NAME
bst\-artifact\-log \- Show logs of an artifact bst\-artifact\-log \- Show logs of an artifact
.SH SYNOPSIS .SH SYNOPSIS
.B bst artifact log .B bst artifact log
[OPTIONS] [ARTIFACTS]... [OPTIONS] [ARTIFACTS]...
.SH DESCRIPTION .SH DESCRIPTION
Show logs of all artifacts Show logs of all artifacts
\ No newline at end of file
.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 .SH NAME
bst\-artifact\-pull \- Pull a built artifact bst\-artifact\-pull \- Pull a built artifact
.SH SYNOPSIS .SH SYNOPSIS
...@@ -7,6 +7,13 @@ bst\-artifact\-pull \- Pull a built artifact ...@@ -7,6 +7,13 @@ bst\-artifact\-pull \- Pull a built artifact
.SH DESCRIPTION .SH DESCRIPTION
Pull a built artifact from the configured remote artifact cache. Pull a built artifact from the configured remote artifact cache.
.PP .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 By default the artifact will be pulled one of the configured caches
if possible, following the usual priority order. If the `--remote` flag if possible, following the usual priority order. If the `--remote` flag
is given, only the specified cache will be queried. is given, only the specified cache will be queried.
...@@ -22,4 +29,4 @@ Specify `--deps` to control which artifacts to pull: ...@@ -22,4 +29,4 @@ Specify `--deps` to control which artifacts to pull:
The dependency artifacts to pull (default: none) The dependency artifacts to pull (default: none)
.TP .TP
\fB\-r,\fP \-\-remote TEXT \fB\-r,\fP \-\-remote TEXT
The URL of the remote cache (defaults to the first configured cache) The URL of the remote cache (defaults to the first configured cache)
\ No newline at end of file
.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 .SH NAME
bst\-artifact\-push \- Push a built artifact bst\-artifact\-push \- Push a built artifact
.SH SYNOPSIS .SH SYNOPSIS
...@@ -7,6 +7,13 @@ bst\-artifact\-push \- Push a built artifact ...@@ -7,6 +7,13 @@ bst\-artifact\-push \- Push a built artifact
.SH DESCRIPTION .SH DESCRIPTION
Push a built artifact to a remote artifact cache. Push a built artifact to a remote artifact cache.
.PP .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 The default destination is the highest priority configured cache. You can
override this by passing a different cache URL with the `--remote` flag. override this by passing a different cache URL with the `--remote` flag.
.PP .PP
...@@ -25,4 +32,4 @@ Specify `--deps` to control which artifacts to push: ...@@ -25,4 +32,4 @@ Specify `--deps` to control which artifacts to push:
The dependencies to push (default: none) The dependencies to push (default: none)
.TP .TP
\fB\-r,\fP \-\-remote TEXT \fB\-r,\fP \-\-remote TEXT
The URL of the remote cache (defaults to the first configured cache) The URL of the remote cache (defaults to the first configured cache)
\ No newline at end of file
.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 .SH NAME
bst-artifact-server \- CAS Artifact Server bst-artifact-server \- CAS Artifact Server
.SH SYNOPSIS .SH SYNOPSIS
...@@ -25,4 +25,4 @@ Allow clients to upload blobs and update artifact cache ...@@ -25,4 +25,4 @@ Allow clients to upload blobs and update artifact cache
Disk head room minimum in bytes Disk head room minimum in bytes
.TP .TP
\fB\-\-head\-room\-max\fP INTEGER \fB\-\-head\-room\-max\fP INTEGER
Disk head room maximum in bytes Disk head room maximum in bytes
\ No newline at end of file
.TH "BST ARTIFACT" "1" "22-Jan-2019" "" "bst artifact Manual" .TH "BST ARTIFACT" "1" "24-Jan-2019" "" "bst artifact Manual"
.SH NAME .SH NAME
bst\-artifact \- Manipulate cached artifacts bst\-artifact \- Manipulate cached artifacts
.SH SYNOPSIS .SH SYNOPSIS
...@@ -22,4 +22,4 @@ Manipulate cached artifacts ...@@ -22,4 +22,4 @@ Manipulate cached artifacts
.PP .PP
\fBlog\fP \fBlog\fP
Show logs of an artifact Show logs of an artifact
See \fBbst artifact-log(1)\fP for full documentation on the \fBlog\fP command. See \fBbst artifact-log(1)\fP for full documentation on the \fBlog\fP command.
\ No newline at end of file
.TH "BST BUILD" "1" "22-Jan-2019" "" "bst build Manual" .TH "BST BUILD" "1" "24-Jan-2019" "" "bst build Manual"
.SH NAME .SH NAME
bst\-build \- Build elements in a pipeline bst\-build \- Build elements in a pipeline
.SH SYNOPSIS .SH SYNOPSIS
...@@ -6,6 +6,13 @@ bst\-build \- Build elements in a pipeline ...@@ -6,6 +6,13 @@ bst\-build \- Build elements in a pipeline
[OPTIONS] [ELEMENTS]... [OPTIONS] [ELEMENTS]...
.SH DESCRIPTION .SH DESCRIPTION
Build elements in a pipeline 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 .SH OPTIONS
.TP .TP
\fB\-\-all\fP \fB\-\-all\fP
...@@ -24,4 +31,4 @@ Except certain dependencies from tracking ...@@ -24,4 +31,4 @@ Except certain dependencies from tracking
Allow tracking to cross junction boundaries Allow tracking to cross junction boundaries
.TP .TP
\fB\-\-track\-save\fP \fB\-\-track\-save\fP
Deprecated: This is ignored Deprecated: This is ignored
\ No newline at end of file
.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
.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
.TH "BST HELP" "1" "22-Jan-2019" "" "bst help Manual" .TH "BST HELP" "1" "24-Jan-2019" "" "bst help Manual"
.SH NAME .SH NAME
bst\-help \- Print usage information bst\-help \- Print usage information
.SH SYNOPSIS .SH SYNOPSIS
...@@ -6,4 +6,4 @@ bst\-help \- Print usage information ...@@ -6,4 +6,4 @@ bst\-help \- Print usage information
[OPTIONS] COMMAND [OPTIONS] COMMAND
.SH DESCRIPTION .SH DESCRIPTION
Print usage information about a given command Print usage information about a given command
\ No newline at end of file
.TH "BST INIT" "1" "22-Jan-2019" "" "bst init Manual" .TH "BST INIT" "1" "24-Jan-2019" "" "bst init Manual"
.SH NAME .SH NAME
bst\-init \- Initialize a new BuildStream project bst\-init \- Initialize a new BuildStream project
.SH SYNOPSIS .SH SYNOPSIS
...@@ -18,10 +18,10 @@ interactive session. ...@@ -18,10 +18,10 @@ interactive session.
The project name to use The project name to use
.TP .TP
\fB\-\-format\-version\fP INTEGER \fB\-\-format\-version\fP INTEGER
The required format version (default: 20) The required format version (default: 21)
.TP .TP
\fB\-\-element\-path\fP PATH \fB\-\-element\-path\fP PATH
The subdirectory to store elements in (default: elements) The subdirectory to store elements in (default: elements)
.TP .TP
\fB\-f,\fP \-\-force \fB\-f,\fP \-\-force
Allow overwriting an existing project.conf Allow overwriting an existing project.conf
\ No newline at end of file
.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
.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
.TH "BST SHELL" "1" "22-Jan-2019" "" "bst shell Manual" .TH "BST SHELL" "1" "24-Jan-2019" "" "bst shell Manual"
.SH NAME .SH NAME
bst\-shell \- Shell into an element's sandbox environment bst\-shell \- Shell into an element's sandbox environment
.SH SYNOPSIS .SH SYNOPSIS
...@@ -7,6 +7,9 @@ bst\-shell \- Shell into an element's sandbox environment ...@@ -7,6 +7,9 @@ bst\-shell \- Shell into an element's sandbox environment
.SH DESCRIPTION .SH DESCRIPTION
Run a command in the target element's sandbox environment Run a command in the target element's sandbox environment
.PP .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 This will stage a temporary sysroot for running the target
element, assuming it has already been built and all required element, assuming it has already been built and all required
artifacts are in the local cache. artifacts are in the local cache.
...@@ -41,4 +44,4 @@ Mount a file or directory into the sandbox ...@@ -41,4 +44,4 @@ Mount a file or directory into the sandbox
Create an isolated build sandbox Create an isolated build sandbox
.TP .TP
\fB\-t,\fP \-\-use\-buildtree [ask|try|always|never] \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 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
.TH "BST SHOW" "1" "22-Jan-2019" "" "bst show Manual" .TH "BST SHOW" "1" "24-Jan-2019" "" "bst show Manual"
.SH NAME .SH NAME
bst\-show \- Show elements in the pipeline bst\-show \- Show elements in the pipeline
.SH SYNOPSIS .SH SYNOPSIS
...@@ -7,6 +7,13 @@ bst\-show \- Show elements in the pipeline ...@@ -7,6 +7,13 @@ bst\-show \- Show elements in the pipeline
.SH DESCRIPTION .SH DESCRIPTION
Show elements in the pipeline Show elements in the pipeline
.PP .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 By default this will show all of the dependencies of the
specified target element. specified target element.
.PP .PP
...@@ -62,4 +69,4 @@ The dependencies to show (default: all) ...@@ -62,4 +69,4 @@ The dependencies to show (default: all)
Staging or alphabetic ordering of dependencies Staging or alphabetic ordering of dependencies
.TP .TP
\fB\-f,\fP \-\-format FORMAT \fB\-f,\fP \-\-format FORMAT
Format string for each element Format string for each element
\ No newline at end of file
.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 .SH NAME
bst\-source\-checkout \- Checkout sources for an element bst\-source\-checkout \- Checkout sources for an element
.SH SYNOPSIS .SH SYNOPSIS
...@@ -6,7 +6,9 @@ bst\-source\-checkout \- Checkout sources for an element ...@@ -6,7 +6,9 @@ bst\-source\-checkout \- Checkout sources for an element
[OPTIONS] [ELEMENT] [LOCATION] [OPTIONS] [ELEMENT] [LOCATION]
.SH DESCRIPTION .SH DESCRIPTION
Checkout sources of an element to the specified location 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 .SH OPTIONS
.TP .TP
\fB\-f,\fP \-\-force \fB\-f,\fP \-\-force
...@@ -25,4 +27,4 @@ Fetch elements if they are not fetched ...@@ -25,4 +27,4 @@ Fetch elements if they are not fetched
Create a tarball from the element's sources instead of a file tree. Create a tarball from the element's sources instead of a file tree.
.TP .TP
\fB\-\-include\-build\-scripts\fP \fB\-\-include\-build\-scripts\fP
.PP .PP
\ No newline at end of file
.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 .SH NAME
bst\-source\-fetch \- Fetch sources in a pipeline bst\-source\-fetch \- Fetch sources in a pipeline
.SH SYNOPSIS .SH SYNOPSIS
...@@ -7,6 +7,13 @@ bst\-source\-fetch \- Fetch sources in a pipeline ...@@ -7,6 +7,13 @@ bst\-source\-fetch \- Fetch sources in a pipeline
.SH DESCRIPTION .SH DESCRIPTION
Fetch sources required to build the pipeline Fetch sources required to build the pipeline
.PP .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 By default this will only try to fetch sources which are
required for the build plan of the specified target element, required for the build plan of the specified target element,
omitting sources for any elements which are already built omitting sources for any elements which are already built
...@@ -30,4 +37,4 @@ The dependencies to fetch (default: plan) ...@@ -30,4 +37,4 @@ The dependencies to fetch (default: plan)
Track new source references before fetching Track new source references before fetching
.TP .TP
\fB\-J,\fP \-\-track\-cross\-junctions \fB\-J,\fP \-\-track\-cross\-junctions
Allow tracking to cross junction boundaries Allow tracking to cross junction boundaries
\ No newline at end of file
.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 .SH NAME
bst\-source\-track \- Track new source references bst\-source\-track \- Track new source references
.SH SYNOPSIS .SH SYNOPSIS
...@@ -8,6 +8,15 @@ bst\-source\-track \- Track new source references ...@@ -8,6 +8,15 @@ bst\-source\-track \- Track new source references
Consults the specified tracking branches for new versions available Consults the specified tracking branches for new versions available
to build and updates the project with any newly available references. to build and updates the project with any newly available references.
.PP .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 By default this will track just the specified element, but you can also
update a whole tree of dependencies in one go. update a whole tree of dependencies in one go.
.PP .PP
...@@ -25,4 +34,4 @@ Except certain dependencies from tracking ...@@ -25,4 +34,4 @@ Except certain dependencies from tracking
The dependencies to track (default: none) The dependencies to track (default: none)
.TP .TP
\fB\-J,\fP \-\-cross\-junctions \fB\-J,\fP \-\-cross\-junctions
Allow crossing junction boundaries Allow crossing junction boundaries
\ No newline at end of file
.TH "BST SOURCE" "1" "22-Jan-2019" "" "bst source Manual" .TH "BST SOURCE" "1" "24-Jan-2019" "" "bst source Manual"
.SH NAME .SH NAME
bst\-source \- Manipulate sources for an element bst\-source \- Manipulate sources for an element
.SH SYNOPSIS .SH SYNOPSIS
...@@ -18,4 +18,4 @@ Manipulate sources for an element ...@@ -18,4 +18,4 @@ Manipulate sources for an element
.PP .PP
\fBcheckout\fP \fBcheckout\fP
Checkout sources for an element Checkout sources for an element
See \fBbst source-checkout(1)\fP for full documentation on the \fBcheckout\fP command. See \fBbst source-checkout(1)\fP for full documentation on the \fBcheckout\fP command.
\ No newline at end of file