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.van.berkom@gmail.com>2018-10-03 13:44:02 +0000
commitd9020e43a26a3723427b94b2a73c25126ad10c77 (patch)
tree479dea089dee42334fa7c75673d54c1bfe9ce673
parent3e797bb9b4d41346fae35eeed7c903062780f8ad (diff)
downloadbuildstream-d9020e43a26a3723427b94b2a73c25126ad10c77.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 7cff6c54b..5c11a363c 100644
--- a/buildstream/utils.py
+++ b/buildstream/utils.py
@@ -563,6 +563,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.
#