Add a comment about usage of fileutil.to_windows_long_path.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>

diff --git a/src/allmydata/util/fileutil.py b/src/allmydata/util/fileutil.py
index 582139e1d19deff7a33326f924b7250be919e875..9a9eb54f73ac817121fc277ee5cc58169700ecb5 100644 (file)
--- a/src/allmydata/util/fileutil.py
+++ b/src/allmydata/util/fileutil.py
@@ -358,6 +358,9 @@ def to_windows_long_path(path):
     # replace it with '\' here.
     path = path.replace(u"/", u"\\")
 
+    # Note that other normalizations such as removing '.' and '..' should
+    # be done outside this function.
+
     if path.startswith(u"\\\\?\\") or path.startswith(u"\\\\.\\"):
         return path
     elif path.startswith(u"\\\\"):