README: clarify that it won't load any .env file

[zsh-autoenv.git] / autoenv.zsh

diff --git a/autoenv.zsh b/autoenv.zsh
index d35b344d16f1efe3e49cfe5a266cf488d3e65f39..0587e2caa082664f5c361c30717bdca3c7af1309 100644 (file)
--- a/autoenv.zsh
+++ b/autoenv.zsh
@@ -4,14 +4,14 @@
 # File to store confirmed authentication into.
 : ${AUTOENV_ENV_FILENAME:=~/.env_auth}
 
-# Name of file to look for when entering directories.
+# Name of the file to look for when entering directories.
 : ${AUTOENV_FILE_ENTER:=.env}
 
-# Name of file to look for when leaving directories.
+# Name of the file to look for when leaving directories.
 # Requires AUTOENV_HANDLE_LEAVE=1.
 : ${AUTOENV_FILE_LEAVE:=.env_leave}
 
-# Look for .env in parent dirs?
+# Look for .env files in parent dirs?
 : ${AUTOENV_LOOK_UPWARDS:=1}
 
 # Handle leave events when changing away from a subtree, where an "enter"
@@ -149,6 +149,7 @@ _autoenv_debug() {
 
 # Generate hash pair for a given file ($1).
 # A fixed hash value can be given as 2nd arg, but is used with tests only.
+# The format is ":$file:$hash:$version".
 _autoenv_hash_pair() {
   local env_file=${1:A}
   local env_shasum=${2:-}