dirnode.py: comments about normalization changes.

diff --git a/src/allmydata/dirnode.py b/src/allmydata/dirnode.py
index 2ae819e7f8cb910bacf3c8a670e99e18d6a1fdf4..53aaddded22b479deeecf5fe923c72ed371925a8 100644 (file)
--- a/src/allmydata/dirnode.py
+++ b/src/allmydata/dirnode.py
@@ -76,6 +76,10 @@ def update_metadata(metadata, new_metadata, now):
 
     return metadata
 
+
+# 'x' at the end of a variable name indicates that it holds a Unicode string that may not
+# be NFC-normalized.
+
 def normalize(namex):
     return unicodedata.normalize('NFC', namex)
 
@@ -325,8 +329,9 @@ class DirectoryNode:
                 raise ValueError("the rwcapdata field of a dirnode in an immutable directory was not empty")
 
             # A name containing characters that are unassigned in one version of Unicode might
-            # not be normalized wrt a later version. Therefore we normalize names going both in
-            # and out of directories.
+            # not be normalized wrt a later version. See the note in section 'Normalization Stability'
+            # at <http://unicode.org/policies/stability_policy.html>.
+            # Therefore we normalize names going both in and out of directories.
             name = normalize(namex_utf8.decode("utf-8"))
 
             rw_uri = ""