comparison mercurial/revlog.py @ 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 1dacf7672556
children e234eda20984
comparison
equal deleted inserted replaced
15834:65f7e986a0d0 15835:fa15869bf95c
401 yield i 401 yield i
402 break 402 break
403 403
404 def findcommonmissing(self, common=None, heads=None): 404 def findcommonmissing(self, common=None, heads=None):
405 """Return a tuple of the ancestors of common and the ancestors of heads 405 """Return a tuple of the ancestors of common and the ancestors of heads
406 that are not ancestors of common. 406 that are not ancestors of common. In revset terminology, we return the
407 407 tuple:
408 More specifically, the second element is a list of nodes N such that 408
409 every N satisfies the following constraints: 409 ::common, (::heads) - (::common)
410
411 1. N is an ancestor of some node in 'heads'
412 2. N is not an ancestor of any node in 'common'
413 410
414 The list is sorted by revision number, meaning it is 411 The list is sorted by revision number, meaning it is
415 topologically sorted. 412 topologically sorted.
416 413
417 'heads' and 'common' are both lists of node IDs. If heads is 414 'heads' and 'common' are both lists of node IDs. If heads is