changeset 15835:fa15869bf95c

revlog: improve docstring for findcommonmissing
author Pierre-Yves David <pierre-yves.david@ens-lyon.org>
date Mon, 09 Jan 2012 04:15:31 +0100
parents 65f7e986a0d0
children 926c9ee8d4be
files mercurial/revlog.py
diffstat 1 files changed, 3 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/revlog.py	Wed Jan 11 15:51:02 2012 +0100
+++ b/mercurial/revlog.py	Mon Jan 09 04:15:31 2012 +0100
@@ -403,13 +403,10 @@
 
     def findcommonmissing(self, common=None, heads=None):
         """Return a tuple of the ancestors of common and the ancestors of heads
-        that are not ancestors of common.
+        that are not ancestors of common. In revset terminology, we return the
+        tuple:
 
-        More specifically, the second element is a list of nodes N such that
-        every N satisfies the following constraints:
-
-          1. N is an ancestor of some node in 'heads'
-          2. N is not an ancestor of any node in 'common'
+          ::common, (::heads) - (::common)
 
         The list is sorted by revision number, meaning it is
         topologically sorted.