Mercurial > hg-stable

changeset 16168:7bbabfe25321

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
copies: add docstring for mergecopies
author Matt Mackall <mpm@selenic.com>
date Fri, 24 Feb 2012 18:21:06 -0600
parents 94a8396c9305
children c12d4aceba79
files mercurial/copies.py
diffstat 1 files changed, 10 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/copies.py	Fri Feb 24 16:52:32 2012 -0600
+++ b/mercurial/copies.py	Fri Feb 24 18:21:06 2012 -0600
@@ -176,7 +176,16 @@
 
 def mergecopies(repo, c1, c2, ca, checkdirs=True):
     """
-    Find moves and copies between context c1 and c2
+    Find moves and copies between context c1 and c2 that are relevant
+    for merging.
+
+    Returns two dicts, "copy" and "diverge".
+
+    "copy" is a mapping from source name -> destination name,
+    where source is in c1 and destination is in c2 or vice-versa.
+
+    "diverge" is a mapping of source name -> list of destination names
+    for divergent renames.
     """
     # avoid silly behavior for update from empty dir
     if not c1 or not c2 or c1 == c2: