]> git.lizzy.rs Git - go-fscache.git/commitdiff
Document the directory name behaviour on Windows
authorDiogo Franco (Kovensky) <diogomfranco@gmail.com>
Tue, 16 Jul 2013 21:29:40 +0000 (18:29 -0300)
committerDiogo Franco (Kovensky) <diogomfranco@gmail.com>
Tue, 16 Jul 2013 21:29:40 +0000 (18:29 -0300)
cachekey.go

index 3c489caef22965033de2c1a1ce01a147e60ec5bd..7d059dafd6af6e7021eba048c606ed80c42e80d7 100755 (executable)
@@ -16,6 +16,10 @@ import (
 // On a list of CacheKeys, the last component is taken to represent a file
 // and all the other components represent the intermediary directories.
 // This means that it's not possible to have subkeys of an existing file key.
+//
+// NOTE: when running on Windows, directories that start with a '.' get the
+// '.' replaced by a '_'. This is because regular Windows tools can't deal
+// with directories starting with a dot.
 type CacheKey interface{}
 
 // All "bad characters" that can't go in Windows paths.