summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMathieu Bridon <bochecha@daitauha.fr>2018-09-28 11:20:20 +0200
committerTristan van Berkom <tristan.vanberkom@codethink.co.uk>2019-08-03 18:04:59 -0400
commitbfbfa57543d5894351758b1c94c155ebd1afc0d3 (patch)
tree12c1df2b79bea4369ac627005625ad16019a0bc2
parent78caec9604729d9dcd1d7108166fb0af6ecb1867 (diff)
downloadbuildstream-tristan/bst-1/cache-quota-docs-fix.tar.gz
data/userconfig.yaml: Document the cache.quota settingtristan/bst-1/cache-quota-docs-fix
-rw-r--r--buildstream/data/userconfig.yaml7
1 files changed, 6 insertions, 1 deletions
diff --git a/buildstream/data/userconfig.yaml b/buildstream/data/userconfig.yaml
index 4711df5e0..24a98c261 100644
--- a/buildstream/data/userconfig.yaml
+++ b/buildstream/data/userconfig.yaml
@@ -26,8 +26,13 @@ logdir: ${XDG_CACHE_HOME}/buildstream/logs
# Cache
#
cache:
- # Size of the artifact cache - BuildStream will attempt to keep the
+ # Size of the artifact cache in bytes - BuildStream will attempt to keep the
# artifact cache within this size.
+ # If the value is suffixed with K, M, G or T, the specified memory size is
+ # parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base
+ # 1024), respectively.
+ # Alternatively, a percentage value may be specified, which is taken relative
+ # to the isize of the file system containing the cache.
quota: infinity
#