Commit eb9481da authored by richardmaw-codethink's avatar richardmaw-codethink Committed by Tristan Van Berkom
Browse files

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.
parent c8fab440

tests/cachekey/update.py

+1 −1
Original line number Diff line number Diff line
@@ -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