summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Maw <richard.maw@codethink.co.uk>2018-09-11 10:47:31 +0100
committerrichardmaw-codethink <richard.maw@codethink.co.uk>2018-09-14 10:37:17 +0000
commit8b03edab845f586769a0cda525b05346b40397cf (patch)
tree20d163f55dfd71896f09f547707e120181a95860
parent13a7d7faf31f4546ccefd5d13d13e14abc328f0b (diff)
downloadbuildstream-richardmaw/subprocess-PWD.tar.gz
Cachekey update helper: Document ensuring . in PYTHONPATHrichardmaw/subprocess-PWD
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