save/vfs: update comments wrt. tree/bupm ordering

[bup.git] / cmd / save-cmd.py

diff --git a/cmd/save-cmd.py b/cmd/save-cmd.py
index 43f41e7477ad4a609f32efd9b079a32c1c643b8a..366f031cab1011cbd3c520e9929d80e01f514485 100755 (executable)
--- a/cmd/save-cmd.py
+++ b/cmd/save-cmd.py
@@ -115,8 +115,11 @@ def eatslash(dir):
 # Since the git tree elements are sorted according to
 # git.shalist_item_sort_key, the metalist items are accumulated as
 # (sort_key, metadata) tuples, and then sorted when the .bupm file is
-# created.  The sort_key must be computed using the element's real
-# name and mode rather than the git mode and (possibly mangled) name.
+# created.  The sort_key should have been computed using the element's
+# mangled name and git mode (after hashsplitting), but the code isn't
+# actually doing that but rather uses the element's real name and mode.
+# This makes things a bit more difficult when reading it back, see
+# vfs.ordered_tree_entries().
 
 # Maintain a stack of information representing the current location in
 # the archive being constructed.  The current path is recorded in