diff mercurial/branchmap.py @ 20245:4edd179fefb8

help: branch names primarily denote the tipmost unclosed branch head Was the behavior correct and the description wrong so it should be updated as in this patch? Or should the code work as the documentation says? Both ways could make some sense ... but none of them are obvious in all cases. One place where it currently cause problems is when the current revision has another branch head that is closer to tip but closed. 'hg rebase' refuses to rebase to that as it only see the tip-most unclosed branch head which is the current revision. /me kind of likes named branches, but no so much how branch closing works ...
author Mads Kiilerich <madski@unity3d.com>
date Thu, 21 Nov 2013 15:17:18 -0500
parents d5d25e541637
children 586ec8fe1c3c
line wrap: on
line diff
--- a/mercurial/branchmap.py	Sun Jan 12 23:28:21 2014 +0100
+++ b/mercurial/branchmap.py	Thu Nov 21 15:17:18 2013 -0500
@@ -167,6 +167,8 @@
             return False
 
     def _branchtip(self, heads):
+        '''Return tuple with last open head in heads and false,
+        otherwise return last closed head and true.'''
         tip = heads[-1]
         closed = True
         for h in reversed(heads):
@@ -177,6 +179,9 @@
         return tip, closed
 
     def branchtip(self, branch):
+        '''Return the tipmost open head on branch head, otherwise return the
+        tipmost closed head on branch.
+        Raise KeyError for unknown branch.'''
         return self._branchtip(self[branch])[0]
 
     def branchheads(self, branch, closed=False):