merge: document some internal return values.
authorGreg Ward <greg-hg@gerg.ca>
Mon, 13 Dec 2010 11:46:31 -0500
changeset 13162 115a9760c382
parent 13161 11eb53464e68
child 13164 b75fc70f0a9f
merge: document some internal return values.
mercurial/hg.py
mercurial/merge.py
--- a/mercurial/hg.py	Thu Dec 16 14:50:37 2010 -0600
+++ b/mercurial/hg.py	Mon Dec 13 11:46:31 2010 -0500
@@ -395,7 +395,8 @@
     return stats[3] > 0
 
 def merge(repo, node, force=None, remind=True):
-    """branch merge with node, resolving changes"""
+    """Branch merge with node, resolving changes. Return true if any
+    unresolved conflicts."""
     stats = mergemod.update(repo, node, True, force, False)
     _showstats(repo, stats)
     if stats[3]:
--- a/mercurial/merge.py	Thu Dec 16 14:50:37 2010 -0600
+++ b/mercurial/merge.py	Mon Dec 13 11:46:31 2010 -0500
@@ -255,6 +255,9 @@
     wctx is the working copy context
     mctx is the context to be merged into the working copy
     actx is the context of the common ancestor
+
+    Return a tuple of counts (updated, merged, removed, unresolved) that
+    describes how many files were affected by the update.
     """
 
     updated, merged, removed, unresolved = 0, 0, 0, 0
@@ -462,6 +465,8 @@
                  use 'hg update -C' to discard changes)
     3 = abort: uncommitted local changes
     4 = incompatible options (checked in commands.py)
+
+    Return the same tuple as applyupdates().
     """
 
     onode = node