changeset 846:4f0b86da5e72

git2hg: update comment now that presence of hg fields is no longer a heuristic In a previous commit we started storing metadata in Git whenever commits originated in Mercurial, so this is no longer a heuristic.
author Siddharth Agarwal <sid0@fb.com>
date Fri, 05 Dec 2014 01:07:41 -0800
parents fffe8883960b
children 82b457515ddb
files hggit/git2hg.py
diffstat 1 files changed, 10 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/hggit/git2hg.py
+++ b/hggit/git2hg.py
@@ -85,12 +85,16 @@
     # commits that originated in Git we'd like to optionally infer rename
     # information to store in Mercurial, but for commits that originated in
     # Mercurial we'd like to disable this. How do we tell whether the commit
-    # originated in Mercurial or in Git? We don't have any firm indicators so we
-    # use a simple heuristic to determine that: if the commit has any extra hg
-    # fields, it definitely originated in Mercurial and we set renames to a
-    # dict. If the commit doesn't, we aren't really sure and we make sure
-    # renames is set to None. Callers can then determine whether to infer rename
-    # information.
+    # originated in Mercurial or in Git? We rely on the presence of extra hg-git
+    # fields in the Git commit.
+    # - Commits exported by hg-git versions past 0.7.0 always store at least one
+    #   hg-git field.
+    # - For commits exported by hg-git versions before 0.7.0, this becomes a
+    #   heuristic: if the commit has any extra hg fields, it definitely originated
+    #   in Mercurial. If the commit doesn't, we aren't really sure.
+    # If we think the commit originated in Mercurial, we set renames to a
+    # dict. If we don't, we set renames to None. Callers can then determine
+    # whether to infer rename information.
     renames = None
     extra = {}
     branch = None