# HG changeset patch
# User Matt Mackall <mpm@selenic.com>
# Date 1330129266 21600
# Node ID 7bbabfe25321c64fb4c71adf0db9ac66eaccfb5d
# Parent  94a8396c9305a72aaffd0a74a9a48b665dcb8e03
copies: add docstring for mergecopies

diff -r 94a8396c9305 -r 7bbabfe25321 mercurial/copies.py
--- 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: