summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorSam Thursfield <sam.thursfield@codethink.co.uk>2017-05-24 15:32:43 +0100
committerSam Thursfield <sam.thursfield@codethink.co.uk>2017-05-24 15:36:17 +0100
commitf3e1aadfdd781c6aed7920545a654a5e9eaff67f (patch)
treeb90e72cce38b27ba343b2335387f0ebe57fd214c /doc/source
parent25325b0d6f8dc93e2bd40d3f81637c36bf0b3158 (diff)
downloadbuildstream-f3e1aadfdd781c6aed7920545a654a5e9eaff67f.tar.gz
Note that OSTree v2017.6 or newer is preferred
There is a GPG bug that can cause a 10 second delay when loading pipelines, if the pipeline includes a signed OSTree repo and the path to the repository is over a certain length. OSTree v2017.6 and newer have internal changes that make hitting this issue much less likely, so let's make users aware of that.
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/install.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 96a68ed3c..7d18cdeed 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -18,7 +18,7 @@ BuildStream requires the following base system requirements:
* python3 >= 3.4
* ruamel.yaml python library
* PyGObject introspection bindings
-* OSTree >= v2016.8
+* OSTree >= v2016.8 (preferrably >= v2017.6 -- see below)
* OStree introspection data
Note that ``ruamel.yaml`` is a pure python library which is normally
@@ -32,6 +32,9 @@ you will additionally need:
* Python 3 development libraries and headers
* git (to checkout buildstream)
+If you use an OSTree version older than v2017.6, you may encounter a 10 second
+delay when loading BuildStream pipelines that include signed OSTree repos. For
+more information see: https://github.com/ostreedev/ostree/issues/883
Here are some examples of how to prepare the base requirements on
some distros.