summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.van.berkom@gmail.com>2019-08-04 01:23:34 +0000
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2019-08-04 01:23:34 +0000
commit6320c08dfff12d3c19e4a98afde03f127c08ebe0 (patch)
tree9034f4c2c93a718cd9904b3fa0df609745ca6eb0
parent967b34ab6c55f9e985e9216d4a8536c1f4c89007 (diff)
parent33e997abcaa320463662280799372310d5480398 (diff)
downloadbuildstream-6320c08dfff12d3c19e4a98afde03f127c08ebe0.tar.gz
Merge branch 'tristan/bst-1/cache-quota-docs-fix' into 'bst-1'
data/userconfig.yaml: Document the cache.quota setting (bst-1) See merge request BuildStream/buildstream!1513
-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
#