summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Maw <richard.maw@codethink.co.uk>2018-09-11 10:47:31 +0100
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2018-09-16 10:22:59 +0000
commiteb9481da88ecbcd823f6e75a4e1cccf2620bc0cc (patch)
tree7daa1de8a7384feca7ae6e39a9d321376724f0c8
parentc8fab4406757cec415d39887a791e910968cb9bb (diff)
downloadbuildstream-eb9481da88ecbcd823f6e75a4e1cccf2620bc0cc.tar.gz
Cachekey update helper: Document ensuring . in PYTHONPATH
The current directory isn't always in the python module search path, so we have to ensure it is for the script to work. Strictly speaking, the user may already have a modified PYTHONPATH at which point PYTHONPATH=".${PYTHONPATH+:$PYTHONPATH}" is necessary, but it's probably premature to overcomplicate the documentation like that before we discover it's a problem.
-rwxr-xr-xtests/cachekey/update.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/tests/cachekey/update.py b/tests/cachekey/update.py
index 8cbee444d..d574d07b3 100755
--- a/tests/cachekey/update.py
+++ b/tests/cachekey/update.py
@@ -5,7 +5,7 @@
#
# Simply run without any arguments, from anywhere, e.g.:
#
-# ./tests/cachekey/update.py
+# PYTHONPATH=. ./tests/cachekey/update.py
#
# After this, add any files which were newly created and commit
# the result in order to adjust the cache key test to changed