summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJürg Billeter <j@bitron.ch>2019-03-12 17:41:55 +0000
committerJürg Billeter <j@bitron.ch>2019-03-16 07:24:58 +0100
commit169acc1afc700d3fe050769c81e8c01af489e9df (patch)
treef6b2b58a725b1d16e1d0203171472a1f162c809a
parentab708fb68d85a633b098c590bd10adf50299cd03 (diff)
downloadbuildstream-169acc1afc700d3fe050769c81e8c01af489e9df.tar.gz
userconfig.yaml: Add disclaimer to cache-buildtrees=never
-rw-r--r--buildstream/data/userconfig.yaml7
1 files changed, 5 insertions, 2 deletions
diff --git a/buildstream/data/userconfig.yaml b/buildstream/data/userconfig.yaml
index d27e56ef2..82a8b5890 100644
--- a/buildstream/data/userconfig.yaml
+++ b/buildstream/data/userconfig.yaml
@@ -40,9 +40,12 @@ cache:
# Whether to cache build trees on artifact creation:
#
- # always - Always cache artifact build tree content
+ # always - Always cache artifact build tree content
# failure - Only cache build trees of failed builds
- # never - Don't cache artifact build tree content
+ # never - Never cache artifact build tree content. This is not recommended
+ # for normal users as this breaks core functionality such as
+ # debugging failed builds and may break additional functionality
+ # in future versions.
#
cache-buildtrees: always