From: Diogo Franco (Kovensky) <diogomfranco@gmail.com>
Date: Tue, 16 Jul 2013 21:29:40 +0000 (-0300)
Subject: Document the directory name behaviour on Windows
X-Git-Tag: v0.0.1~5
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=3738c19961eff52e36c580f77e5d1f02497c3c90;p=go-fscache.git

Document the directory name behaviour on Windows
---

diff --git a/cachekey.go b/cachekey.go
index 3c489ca..7d059da 100755
--- a/cachekey.go
+++ b/cachekey.go
@@ -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.