summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-10-03 22:00:22 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-10-03 22:04:03 +0900
commitc02a1ae86bb2dacf0f2b9f1e9254516304b32731 (patch)
tree85e042865af5e341ca56eb1ca9185d49a0774032
parent10d6998819c75e8be8d01bec6c98a666b6ee4e08 (diff)
downloadbuildstream-c02a1ae86bb2dacf0f2b9f1e9254516304b32731.tar.gz
utils.py: Document _get_dir_size() expectations.
This function assumes that files do not disappear while walking the given directory.
-rw-r--r--buildstream/utils.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/buildstream/utils.py b/buildstream/utils.py
index 1bb504470..34c0f898b 100644
--- a/buildstream/utils.py
+++ b/buildstream/utils.py
@@ -557,6 +557,9 @@ def save_file_atomic(filename, mode='w', *, buffering=-1, encoding=None,
#
# Get the disk usage of a given directory in bytes.
#
+# This function assumes that files do not inadvertantly
+# disappear while this function is running.
+#
# Arguments:
# (str) The path whose size to check.
#