bookmarks: cache reverse mapping (issue5868)

I chose a simpler implementation. If the initial cost of building reverse
mapping is significant, we'll have to move it under @propertycache.

The nodemap could be a dict of sets, but I think keeping a sorted list is
better since each node is likely to have zero/one bookmark.

Micro-benchmark with 1001 bookmarks and 1001 revisions:

  $ for n in `seq 0 1000`; do touch $n; hg book book$n; hg ci -qAm$n; done
  $ hg bookmarks --time > /dev/null
  (orig) time: real 0.040 secs (user 0.050+0.000 sys 0.000+0.000)
  (new)  time: real 0.040 secs (user 0.040+0.000 sys 0.010+0.000)
  $ hg log -T '{bookmarks}\n' --time > /dev/null
  (orig) time: real 0.160 secs (user 0.160+0.000 sys 0.000+0.000)
  (new)  time: real 0.090 secs (user 0.100+0.000 sys 0.000+0.000)

mercurial/bookmarks.py

@@ -1,945 +1,965 b''
 # Mercurial bookmark support code
 #
 # Copyright 2008 David Soria Parra <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import errno
 import struct
 
 from .i18n import _
 from .node import (
     bin,
     hex,
     short,
     wdirid,
 )
 from . import (
     encoding,
     error,
     obsutil,
     pycompat,
     scmutil,
     txnutil,
     util,
 )
 
 # label constants
 # until 3.5, bookmarks.current was the advertised name, not
 # bookmarks.active, so we must use both to avoid breaking old
 # custom styles
 activebookmarklabel = 'bookmarks.active bookmarks.current'
 
 def _getbkfile(repo):
     """Hook so that extensions that mess with the store can hook bm storage.
 
     For core, this just handles wether we should see pending
     bookmarks or the committed ones. Other extensions (like share)
     may need to tweak this behavior further.
     """
     fp, pending = txnutil.trypending(repo.root, repo.vfs, 'bookmarks')
     return fp
 
 class bmstore(object):
     """Storage for bookmarks.
 
     This object should do all bookmark-related reads and writes, so
     that it's fairly simple to replace the storage underlying
     bookmarks without having to clone the logic surrounding
     bookmarks. This type also should manage the active bookmark, if
     any.
 
     This particular bmstore implementation stores bookmarks as
     {hash}\s{name}\n (the same format as localtags) in
     .hg/bookmarks. The mapping is stored as {name: nodeid}.
     """
 
     def __init__(self, repo):
         self._repo = repo
         self._refmap = refmap = {}  # refspec: node
+        self._nodemap = nodemap = {}  # node: sorted([refspec, ...])
         self._clean = True
         self._aclean = True
         nm = repo.changelog.nodemap
         tonode = bin # force local lookup
         try:
             with _getbkfile(repo) as bkfile:
                 for line in bkfile:
                     line = line.strip()
                     if not line:
                         continue
                     try:
                         sha, refspec = line.split(' ', 1)
                         node = tonode(sha)
                         if node in nm:
                             refspec = encoding.tolocal(refspec)
                             refmap[refspec] = node
+                            nrefs = nodemap.get(node)
+                            if nrefs is None:
+                                nodemap[node] = [refspec]
+                            else:
+                                nrefs.append(refspec)
+                                if nrefs[-2] > refspec:
+                                    # bookmarks weren't sorted before 4.5
+                                    nrefs.sort()
                     except (TypeError, ValueError):
                         # TypeError:
                         # - bin(...)
                         # ValueError:
                         # - node in nm, for non-20-bytes entry
                         # - split(...), for string without ' '
                         repo.ui.warn(_('malformed line in .hg/bookmarks: %r\n')
                                      % pycompat.bytestr(line))
         except IOError as inst:
             if inst.errno != errno.ENOENT:
                 raise
         self._active = _readactive(repo, self)
 
     @property
     def active(self):
         return self._active
 
     @active.setter
     def active(self, mark):
         if mark is not None and mark not in self._refmap:
             raise AssertionError('bookmark %s does not exist!' % mark)
 
         self._active = mark
         self._aclean = False
 
     def __len__(self):
         return len(self._refmap)
 
     def __iter__(self):
         return iter(self._refmap)
 
     def iteritems(self):
         return self._refmap.iteritems()
 
     def items(self):
         return self._refmap.items()
 
     # TODO: maybe rename to allnames()?
     def keys(self):
         return self._refmap.keys()
 
     # TODO: maybe rename to allnodes()? but nodes would have to be deduplicated
+    # could be self._nodemap.keys()
     def values(self):
         return self._refmap.values()
 
     def __contains__(self, mark):
         return mark in self._refmap
 
     def __getitem__(self, mark):
         return self._refmap[mark]
 
     def get(self, mark, default=None):
         return self._refmap.get(mark, default)
 
     def _set(self, mark, node):
         self._clean = False
+        if mark in self._refmap:
+            self._del(mark)
         self._refmap[mark] = node
+        nrefs = self._nodemap.get(node)
+        if nrefs is None:
+            self._nodemap[node] = [mark]
+        else:
+            nrefs.append(mark)
+            nrefs.sort()
 
     def _del(self, mark):
         self._clean = False
-        del self._refmap[mark]
+        node = self._refmap.pop(mark)
+        nrefs = self._nodemap[node]
+        if len(nrefs) == 1:
+            assert nrefs[0] == mark
+            del self._nodemap[node]
+        else:
+            nrefs.remove(mark)
 
     def names(self, node):
         """Return a sorted list of bookmarks pointing to the specified node"""
-        marks = []
-        for m, n in self._refmap.iteritems():
-            if n == node:
-                marks.append(m)
-        return sorted(marks)
+        return self._nodemap.get(node, [])
 
     def changectx(self, mark):
         node = self._refmap[mark]
         return self._repo[node]
 
     def applychanges(self, repo, tr, changes):
         """Apply a list of changes to bookmarks
         """
         bmchanges = tr.changes.get('bookmarks')
         for name, node in changes:
             old = self._refmap.get(name)
             if node is None:
                 self._del(name)
             else:
                 self._set(name, node)
             if bmchanges is not None:
                 # if a previous value exist preserve the "initial" value
                 previous = bmchanges.get(name)
                 if previous is not None:
                     old = previous[0]
                 bmchanges[name] = (old, node)
         self._recordchange(tr)
 
     def _recordchange(self, tr):
         """record that bookmarks have been changed in a transaction
 
         The transaction is then responsible for updating the file content."""
         tr.addfilegenerator('bookmarks', ('bookmarks',), self._write,
                             location='plain')
         tr.hookargs['bookmark_moved'] = '1'
 
     def _writerepo(self, repo):
         """Factored out for extensibility"""
         rbm = repo._bookmarks
         if rbm.active not in self._refmap:
             rbm.active = None
             rbm._writeactive()
 
         with repo.wlock():
             file_ = repo.vfs('bookmarks', 'w', atomictemp=True,
                              checkambig=True)
             try:
                 self._write(file_)
             except: # re-raises
                 file_.discard()
                 raise
             finally:
                 file_.close()
 
     def _writeactive(self):
         if self._aclean:
             return
         with self._repo.wlock():
             if self._active is not None:
                 f = self._repo.vfs('bookmarks.current', 'w', atomictemp=True,
                                    checkambig=True)
                 try:
                     f.write(encoding.fromlocal(self._active))
                 finally:
                     f.close()
             else:
                 self._repo.vfs.tryunlink('bookmarks.current')
         self._aclean = True
 
     def _write(self, fp):
         for name, node in sorted(self._refmap.iteritems()):
             fp.write("%s %s\n" % (hex(node), encoding.fromlocal(name)))
         self._clean = True
         self._repo.invalidatevolatilesets()
 
     def expandname(self, bname):
         if bname == '.':
             if self.active:
                 return self.active
             else:
                 raise error.Abort(_("no active bookmark"))
         return bname
 
     def checkconflict(self, mark, force=False, target=None):
         """check repo for a potential clash of mark with an existing bookmark,
         branch, or hash
 
         If target is supplied, then check that we are moving the bookmark
         forward.
 
         If force is supplied, then forcibly move the bookmark to a new commit
         regardless if it is a move forward.
 
         If divergent bookmark are to be deleted, they will be returned as list.
         """
         cur = self._repo['.'].node()
         if mark in self._refmap and not force:
             if target:
                 if self._refmap[mark] == target and target == cur:
                     # re-activating a bookmark
                     return []
                 rev = self._repo[target].rev()
                 anc = self._repo.changelog.ancestors([rev])
                 bmctx = self.changectx(mark)
                 divs = [self._refmap[b] for b in self._refmap
                         if b.split('@', 1)[0] == mark.split('@', 1)[0]]
 
                 # allow resolving a single divergent bookmark even if moving
                 # the bookmark across branches when a revision is specified
                 # that contains a divergent bookmark
                 if bmctx.rev() not in anc and target in divs:
                     return divergent2delete(self._repo, [target], mark)
 
                 deletefrom = [b for b in divs
                               if self._repo[b].rev() in anc or b == target]
                 delbms = divergent2delete(self._repo, deletefrom, mark)
                 if validdest(self._repo, bmctx, self._repo[target]):
                     self._repo.ui.status(
                         _("moving bookmark '%s' forward from %s\n") %
                         (mark, short(bmctx.node())))
                     return delbms
             raise error.Abort(_("bookmark '%s' already exists "
                                 "(use -f to force)") % mark)
         if ((mark in self._repo.branchmap() or
              mark == self._repo.dirstate.branch()) and not force):
             raise error.Abort(
                 _("a bookmark cannot have the name of an existing branch"))
         if len(mark) > 3 and not force:
             try:
                 shadowhash = scmutil.isrevsymbol(self._repo, mark)
             except error.LookupError:  # ambiguous identifier
                 shadowhash = False
             if shadowhash:
                 self._repo.ui.warn(
                     _("bookmark %s matches a changeset hash\n"
                       "(did you leave a -r out of an 'hg bookmark' "
                       "command?)\n")
                     % mark)
         return []
 
 def _readactive(repo, marks):
     """
     Get the active bookmark. We can have an active bookmark that updates
     itself as we commit. This function returns the name of that bookmark.
     It is stored in .hg/bookmarks.current
     """
     mark = None
     try:
         file = repo.vfs('bookmarks.current')
     except IOError as inst:
         if inst.errno != errno.ENOENT:
             raise
         return None
     try:
         # No readline() in osutil.posixfile, reading everything is
         # cheap.
         # Note that it's possible for readlines() here to raise
         # IOError, since we might be reading the active mark over
         # static-http which only tries to load the file when we try
         # to read from it.
         mark = encoding.tolocal((file.readlines() or [''])[0])
         if mark == '' or mark not in marks:
             mark = None
     except IOError as inst:
         if inst.errno != errno.ENOENT:
             raise
         return None
     finally:
         file.close()
     return mark
 
 def activate(repo, mark):
     """
     Set the given bookmark to be 'active', meaning that this bookmark will
     follow new commits that are made.
     The name is recorded in .hg/bookmarks.current
     """
     repo._bookmarks.active = mark
     repo._bookmarks._writeactive()
 
 def deactivate(repo):
     """
     Unset the active bookmark in this repository.
     """
     repo._bookmarks.active = None
     repo._bookmarks._writeactive()
 
 def isactivewdirparent(repo):
     """
     Tell whether the 'active' bookmark (the one that follows new commits)
     points to one of the parents of the current working directory (wdir).
 
     While this is normally the case, it can on occasion be false; for example,
     immediately after a pull, the active bookmark can be moved to point
     to a place different than the wdir. This is solved by running `hg update`.
     """
     mark = repo._activebookmark
     marks = repo._bookmarks
     parents = [p.node() for p in repo[None].parents()]
     return (mark in marks and marks[mark] in parents)
 
 def divergent2delete(repo, deletefrom, bm):
     """find divergent versions of bm on nodes in deletefrom.
 
     the list of bookmark to delete."""
     todelete = []
     marks = repo._bookmarks
     divergent = [b for b in marks if b.split('@', 1)[0] == bm.split('@', 1)[0]]
     for mark in divergent:
         if mark == '@' or '@' not in mark:
             # can't be divergent by definition
             continue
         if mark and marks[mark] in deletefrom:
             if mark != bm:
                 todelete.append(mark)
     return todelete
 
 def headsforactive(repo):
     """Given a repo with an active bookmark, return divergent bookmark nodes.
 
     Args:
       repo: A repository with an active bookmark.
 
     Returns:
       A list of binary node ids that is the full list of other
       revisions with bookmarks divergent from the active bookmark. If
       there were no divergent bookmarks, then this list will contain
       only one entry.
     """
     if not repo._activebookmark:
         raise ValueError(
             'headsforactive() only makes sense with an active bookmark')
     name = repo._activebookmark.split('@', 1)[0]
     heads = []
     for mark, n in repo._bookmarks.iteritems():
         if mark.split('@', 1)[0] == name:
             heads.append(n)
     return heads
 
 def calculateupdate(ui, repo):
     '''Return a tuple (activemark, movemarkfrom) indicating the active bookmark
     and where to move the active bookmark from, if needed.'''
     checkout, movemarkfrom = None, None
     activemark = repo._activebookmark
     if isactivewdirparent(repo):
         movemarkfrom = repo['.'].node()
     elif activemark:
         ui.status(_("updating to active bookmark %s\n") % activemark)
         checkout = activemark
     return (checkout, movemarkfrom)
 
 def update(repo, parents, node):
     deletefrom = parents
     marks = repo._bookmarks
     active = marks.active
     if not active:
         return False
 
     bmchanges = []
     if marks[active] in parents:
         new = repo[node]
         divs = [marks.changectx(b) for b in marks
                 if b.split('@', 1)[0] == active.split('@', 1)[0]]
         anc = repo.changelog.ancestors([new.rev()])
         deletefrom = [b.node() for b in divs if b.rev() in anc or b == new]
         if validdest(repo, marks.changectx(active), new):
             bmchanges.append((active, new.node()))
 
     for bm in divergent2delete(repo, deletefrom, active):
         bmchanges.append((bm, None))
 
     if bmchanges:
         with repo.lock(), repo.transaction('bookmark') as tr:
             marks.applychanges(repo, tr, bmchanges)
     return bool(bmchanges)
 
 def listbinbookmarks(repo):
     # We may try to list bookmarks on a repo type that does not
     # support it (e.g., statichttprepository).
     marks = getattr(repo, '_bookmarks', {})
 
     hasnode = repo.changelog.hasnode
     for k, v in marks.iteritems():
         # don't expose local divergent bookmarks
         if hasnode(v) and ('@' not in k or k.endswith('@')):
             yield k, v
 
 def listbookmarks(repo):
     d = {}
     for book, node in listbinbookmarks(repo):
         d[book] = hex(node)
     return d
 
 def pushbookmark(repo, key, old, new):
     with repo.wlock(), repo.lock(), repo.transaction('bookmarks') as tr:
         marks = repo._bookmarks
         existing = hex(marks.get(key, ''))
         if existing != old and existing != new:
             return False
         if new == '':
             changes = [(key, None)]
         else:
             if new not in repo:
                 return False
             changes = [(key, repo[new].node())]
         marks.applychanges(repo, tr, changes)
         return True
 
 def comparebookmarks(repo, srcmarks, dstmarks, targets=None):
     '''Compare bookmarks between srcmarks and dstmarks
 
     This returns tuple "(addsrc, adddst, advsrc, advdst, diverge,
     differ, invalid)", each are list of bookmarks below:
 
     :addsrc:  added on src side (removed on dst side, perhaps)
     :adddst:  added on dst side (removed on src side, perhaps)
     :advsrc:  advanced on src side
     :advdst:  advanced on dst side
     :diverge: diverge
     :differ:  changed, but changeset referred on src is unknown on dst
     :invalid: unknown on both side
     :same:    same on both side
 
     Each elements of lists in result tuple is tuple "(bookmark name,
     changeset ID on source side, changeset ID on destination
     side)". Each changeset IDs are 40 hexadecimal digit string or
     None.
 
     Changeset IDs of tuples in "addsrc", "adddst", "differ" or
      "invalid" list may be unknown for repo.
 
     If "targets" is specified, only bookmarks listed in it are
     examined.
     '''
 
     if targets:
         bset = set(targets)
     else:
         srcmarkset = set(srcmarks)
         dstmarkset = set(dstmarks)
         bset = srcmarkset | dstmarkset
 
     results = ([], [], [], [], [], [], [], [])
     addsrc = results[0].append
     adddst = results[1].append
     advsrc = results[2].append
     advdst = results[3].append
     diverge = results[4].append
     differ = results[5].append
     invalid = results[6].append
     same = results[7].append
 
     for b in sorted(bset):
         if b not in srcmarks:
             if b in dstmarks:
                 adddst((b, None, dstmarks[b]))
             else:
                 invalid((b, None, None))
         elif b not in dstmarks:
             addsrc((b, srcmarks[b], None))
         else:
             scid = srcmarks[b]
             dcid = dstmarks[b]
             if scid == dcid:
                 same((b, scid, dcid))
             elif scid in repo and dcid in repo:
                 sctx = repo[scid]
                 dctx = repo[dcid]
                 if sctx.rev() < dctx.rev():
                     if validdest(repo, sctx, dctx):
                         advdst((b, scid, dcid))
                     else:
                         diverge((b, scid, dcid))
                 else:
                     if validdest(repo, dctx, sctx):
                         advsrc((b, scid, dcid))
                     else:
                         diverge((b, scid, dcid))
             else:
                 # it is too expensive to examine in detail, in this case
                 differ((b, scid, dcid))
 
     return results
 
 def _diverge(ui, b, path, localmarks, remotenode):
     '''Return appropriate diverged bookmark for specified ``path``
 
     This returns None, if it is failed to assign any divergent
     bookmark name.
 
     This reuses already existing one with "@number" suffix, if it
     refers ``remotenode``.
     '''
     if b == '@':
         b = ''
     # try to use an @pathalias suffix
     # if an @pathalias already exists, we overwrite (update) it
     if path.startswith("file:"):
         path = util.url(path).path
     for p, u in ui.configitems("paths"):
         if u.startswith("file:"):
             u = util.url(u).path
         if path == u:
             return '%s@%s' % (b, p)
 
     # assign a unique "@number" suffix newly
     for x in range(1, 100):
         n = '%s@%d' % (b, x)
         if n not in localmarks or localmarks[n] == remotenode:
             return n
 
     return None
 
 def unhexlifybookmarks(marks):
     binremotemarks = {}
     for name, node in marks.items():
         binremotemarks[name] = bin(node)
     return binremotemarks
 
 _binaryentry = struct.Struct('>20sH')
 
 def binaryencode(bookmarks):
     """encode a '(bookmark, node)' iterable into a binary stream
 
     the binary format is:
 
         <node><bookmark-length><bookmark-name>
 
     :node: is a 20 bytes binary node,
     :bookmark-length: an unsigned short,
     :bookmark-name: the name of the bookmark (of length <bookmark-length>)
 
     wdirid (all bits set) will be used as a special value for "missing"
     """
     binarydata = []
     for book, node in bookmarks:
         if not node: # None or ''
             node = wdirid
         binarydata.append(_binaryentry.pack(node, len(book)))
         binarydata.append(book)
     return ''.join(binarydata)
 
 def binarydecode(stream):
     """decode a binary stream into an '(bookmark, node)' iterable
 
     the binary format is:
 
         <node><bookmark-length><bookmark-name>
 
     :node: is a 20 bytes binary node,
     :bookmark-length: an unsigned short,
     :bookmark-name: the name of the bookmark (of length <bookmark-length>))
 
     wdirid (all bits set) will be used as a special value for "missing"
     """
     entrysize = _binaryentry.size
     books = []
     while True:
         entry = stream.read(entrysize)
         if len(entry) < entrysize:
             if entry:
                 raise error.Abort(_('bad bookmark stream'))
             break
         node, length = _binaryentry.unpack(entry)
         bookmark = stream.read(length)
         if len(bookmark) < length:
             if entry:
                 raise error.Abort(_('bad bookmark stream'))
         if node == wdirid:
             node = None
         books.append((bookmark, node))
     return books
 
 def updatefromremote(ui, repo, remotemarks, path, trfunc, explicit=()):
     ui.debug("checking for updated bookmarks\n")
     localmarks = repo._bookmarks
     (addsrc, adddst, advsrc, advdst, diverge, differ, invalid, same
     ) = comparebookmarks(repo, remotemarks, localmarks)
 
     status = ui.status
     warn = ui.warn
     if ui.configbool('ui', 'quietbookmarkmove'):
         status = warn = ui.debug
 
     explicit = set(explicit)
     changed = []
     for b, scid, dcid in addsrc:
         if scid in repo: # add remote bookmarks for changes we already have
             changed.append((b, scid, status,
                             _("adding remote bookmark %s\n") % (b)))
         elif b in explicit:
             explicit.remove(b)
             ui.warn(_("remote bookmark %s points to locally missing %s\n")
                     % (b, hex(scid)[:12]))
 
     for b, scid, dcid in advsrc:
         changed.append((b, scid, status,
                         _("updating bookmark %s\n") % (b)))
     # remove normal movement from explicit set
     explicit.difference_update(d[0] for d in changed)
 
     for b, scid, dcid in diverge:
         if b in explicit:
             explicit.discard(b)
             changed.append((b, scid, status,
                             _("importing bookmark %s\n") % (b)))
         else:
             db = _diverge(ui, b, path, localmarks, scid)
             if db:
                 changed.append((db, scid, warn,
                                 _("divergent bookmark %s stored as %s\n") %
                                 (b, db)))
             else:
                 warn(_("warning: failed to assign numbered name "
                        "to divergent bookmark %s\n") % (b))
     for b, scid, dcid in adddst + advdst:
         if b in explicit:
             explicit.discard(b)
             changed.append((b, scid, status,
                             _("importing bookmark %s\n") % (b)))
     for b, scid, dcid in differ:
         if b in explicit:
             explicit.remove(b)
             ui.warn(_("remote bookmark %s points to locally missing %s\n")
                     % (b, hex(scid)[:12]))
 
     if changed:
         tr = trfunc()
         changes = []
         for b, node, writer, msg in sorted(changed):
             changes.append((b, node))
             writer(msg)
         localmarks.applychanges(repo, tr, changes)
 
 def incoming(ui, repo, peer):
     '''Show bookmarks incoming from other to repo
     '''
     ui.status(_("searching for changed bookmarks\n"))
 
     with peer.commandexecutor() as e:
         remotemarks = unhexlifybookmarks(e.callcommand('listkeys', {
             'namespace': 'bookmarks',
         }).result())
 
     r = comparebookmarks(repo, remotemarks, repo._bookmarks)
     addsrc, adddst, advsrc, advdst, diverge, differ, invalid, same = r
 
     incomings = []
     if ui.debugflag:
         getid = lambda id: id
     else:
         getid = lambda id: id[:12]
     if ui.verbose:
         def add(b, id, st):
             incomings.append("   %-25s %s %s\n" % (b, getid(id), st))
     else:
         def add(b, id, st):
             incomings.append("   %-25s %s\n" % (b, getid(id)))
     for b, scid, dcid in addsrc:
         # i18n: "added" refers to a bookmark
         add(b, hex(scid), _('added'))
     for b, scid, dcid in advsrc:
         # i18n: "advanced" refers to a bookmark
         add(b, hex(scid), _('advanced'))
     for b, scid, dcid in diverge:
         # i18n: "diverged" refers to a bookmark
         add(b, hex(scid), _('diverged'))
     for b, scid, dcid in differ:
         # i18n: "changed" refers to a bookmark
         add(b, hex(scid), _('changed'))
 
     if not incomings:
         ui.status(_("no changed bookmarks found\n"))
         return 1
 
     for s in sorted(incomings):
         ui.write(s)
 
     return 0
 
 def outgoing(ui, repo, other):
     '''Show bookmarks outgoing from repo to other
     '''
     ui.status(_("searching for changed bookmarks\n"))
 
     remotemarks = unhexlifybookmarks(other.listkeys('bookmarks'))
     r = comparebookmarks(repo, repo._bookmarks, remotemarks)
     addsrc, adddst, advsrc, advdst, diverge, differ, invalid, same = r
 
     outgoings = []
     if ui.debugflag:
         getid = lambda id: id
     else:
         getid = lambda id: id[:12]
     if ui.verbose:
         def add(b, id, st):
             outgoings.append("   %-25s %s %s\n" % (b, getid(id), st))
     else:
         def add(b, id, st):
             outgoings.append("   %-25s %s\n" % (b, getid(id)))
     for b, scid, dcid in addsrc:
         # i18n: "added refers to a bookmark
         add(b, hex(scid), _('added'))
     for b, scid, dcid in adddst:
         # i18n: "deleted" refers to a bookmark
         add(b, ' ' * 40, _('deleted'))
     for b, scid, dcid in advsrc:
         # i18n: "advanced" refers to a bookmark
         add(b, hex(scid), _('advanced'))
     for b, scid, dcid in diverge:
         # i18n: "diverged" refers to a bookmark
         add(b, hex(scid), _('diverged'))
     for b, scid, dcid in differ:
         # i18n: "changed" refers to a bookmark
         add(b, hex(scid), _('changed'))
 
     if not outgoings:
         ui.status(_("no changed bookmarks found\n"))
         return 1
 
     for s in sorted(outgoings):
         ui.write(s)
 
     return 0
 
 def summary(repo, peer):
     '''Compare bookmarks between repo and other for "hg summary" output
 
     This returns "(# of incoming, # of outgoing)" tuple.
     '''
     with peer.commandexecutor() as e:
         remotemarks = unhexlifybookmarks(e.callcommand('listkeys', {
             'namespace': 'bookmarks',
         }).result())
 
     r = comparebookmarks(repo, remotemarks, repo._bookmarks)
     addsrc, adddst, advsrc, advdst, diverge, differ, invalid, same = r
     return (len(addsrc), len(adddst))
 
 def validdest(repo, old, new):
     """Is the new bookmark destination a valid update from the old one"""
     repo = repo.unfiltered()
     if old == new:
         # Old == new -> nothing to update.
         return False
     elif not old:
         # old is nullrev, anything is valid.
         # (new != nullrev has been excluded by the previous check)
         return True
     elif repo.obsstore:
         return new.node() in obsutil.foreground(repo, [old.node()])
     else:
         # still an independent clause as it is lazier (and therefore faster)
         return old.descendant(new)
 
 def checkformat(repo, mark):
     """return a valid version of a potential bookmark name
 
     Raises an abort error if the bookmark name is not valid.
     """
     mark = mark.strip()
     if not mark:
         raise error.Abort(_("bookmark names cannot consist entirely of "
                             "whitespace"))
     scmutil.checknewlabel(repo, mark, 'bookmark')
     return mark
 
 def delete(repo, tr, names):
     """remove a mark from the bookmark store
 
     Raises an abort error if mark does not exist.
     """
     marks = repo._bookmarks
     changes = []
     for mark in names:
         if mark not in marks:
             raise error.Abort(_("bookmark '%s' does not exist") % mark)
         if mark == repo._activebookmark:
             deactivate(repo)
         changes.append((mark, None))
     marks.applychanges(repo, tr, changes)
 
 def rename(repo, tr, old, new, force=False, inactive=False):
     """rename a bookmark from old to new
 
     If force is specified, then the new name can overwrite an existing
     bookmark.
 
     If inactive is specified, then do not activate the new bookmark.
 
     Raises an abort error if old is not in the bookmark store.
     """
     marks = repo._bookmarks
     mark = checkformat(repo, new)
     if old not in marks:
         raise error.Abort(_("bookmark '%s' does not exist") % old)
     changes = []
     for bm in marks.checkconflict(mark, force):
         changes.append((bm, None))
     changes.extend([(mark, marks[old]), (old, None)])
     marks.applychanges(repo, tr, changes)
     if repo._activebookmark == old and not inactive:
         activate(repo, mark)
 
 def addbookmarks(repo, tr, names, rev=None, force=False, inactive=False):
     """add a list of bookmarks
 
     If force is specified, then the new name can overwrite an existing
     bookmark.
 
     If inactive is specified, then do not activate any bookmark. Otherwise, the
     first bookmark is activated.
 
     Raises an abort error if old is not in the bookmark store.
     """
     marks = repo._bookmarks
     cur = repo['.'].node()
     newact = None
     changes = []
     hiddenrev = None
 
     # unhide revs if any
     if rev:
         repo = scmutil.unhidehashlikerevs(repo, [rev], 'nowarn')
 
     for mark in names:
         mark = checkformat(repo, mark)
         if newact is None:
             newact = mark
         if inactive and mark == repo._activebookmark:
             deactivate(repo)
             return
         tgt = cur
         if rev:
             ctx = scmutil.revsingle(repo, rev)
             if ctx.hidden():
                 hiddenrev = ctx.hex()[:12]
             tgt = ctx.node()
         for bm in marks.checkconflict(mark, force, tgt):
             changes.append((bm, None))
         changes.append((mark, tgt))
 
     if hiddenrev:
         repo.ui.warn(_("bookmarking hidden changeset %s\n") % hiddenrev)
 
         if ctx.obsolete():
             msg = obsutil._getfilteredreason(repo, "%s" % hiddenrev, ctx)
             repo.ui.warn("(%s)\n" % msg)
 
     marks.applychanges(repo, tr, changes)
     if not inactive and cur == marks[newact] and not rev:
         activate(repo, newact)
     elif cur != tgt and newact == repo._activebookmark:
         deactivate(repo)
 
 def _printbookmarks(ui, repo, bmarks, **opts):
     """private method to print bookmarks
 
     Provides a way for extensions to control how bookmarks are printed (e.g.
     prepend or postpend names)
     """
     opts = pycompat.byteskwargs(opts)
     fm = ui.formatter('bookmarks', opts)
     hexfn = fm.hexfunc
     if len(bmarks) == 0 and fm.isplain():
         ui.status(_("no bookmarks set\n"))
     for bmark, (n, prefix, label) in sorted(bmarks.iteritems()):
         fm.startitem()
         if not ui.quiet:
             fm.plain(' %s ' % prefix, label=label)
         fm.write('bookmark', '%s', bmark, label=label)
         pad = " " * (25 - encoding.colwidth(bmark))
         fm.condwrite(not ui.quiet, 'rev node', pad + ' %d:%s',
                      repo.changelog.rev(n), hexfn(n), label=label)
         fm.data(active=(activebookmarklabel in label))
         fm.plain('\n')
     fm.end()
 
 def printbookmarks(ui, repo, **opts):
     """print bookmarks to a formatter
 
     Provides a way for extensions to control how bookmarks are printed.
     """
     marks = repo._bookmarks
     bmarks = {}
     for bmark, n in sorted(marks.iteritems()):
         active = repo._activebookmark
         if bmark == active:
             prefix, label = '*', activebookmarklabel
         else:
             prefix, label = ' ', ''
 
         bmarks[bmark] = (n, prefix, label)
     _printbookmarks(ui, repo, bmarks, **opts)
 
 def preparehookargs(name, old, new):
     if new is None:
         new = ''
     if old is None:
         old = ''
     return {'bookmark': name,
             'node': hex(new),
             'oldnode': hex(old)}

tests/test-bookmarks.t

@@ -1,1164 +1,1177 b''
 
   $ hg init repo
   $ cd repo
 
   $ cat > $TESTTMP/hook.sh <<'EOF'
   > echo "test-hook-bookmark: $HG_BOOKMARK:  $HG_OLDNODE -> $HG_NODE"
   > EOF
   $ TESTHOOK="hooks.txnclose-bookmark.test=sh $TESTTMP/hook.sh"
 
 no bookmarks
 
   $ hg bookmarks
   no bookmarks set
 
   $ hg bookmarks -Tjson
   [
   ]
 
 bookmark rev -1
 
   $ hg bookmark X --config "$TESTHOOK"
   test-hook-bookmark: X:   -> 0000000000000000000000000000000000000000
 
 list bookmarks
 
   $ hg bookmarks
    * X                         -1:000000000000
 
 list bookmarks with color
 
   $ hg --config extensions.color= --config color.mode=ansi \
   >    bookmarks --color=always
   \x1b[0;32m * \x1b[0m\x1b[0;32mX\x1b[0m\x1b[0;32m                         -1:000000000000\x1b[0m (esc)
 
   $ echo a > a
   $ hg add a
   $ hg commit -m 0 --config "$TESTHOOK"
   test-hook-bookmark: X:  0000000000000000000000000000000000000000 -> f7b1eb17ad24730a1651fccd46c43826d1bbc2ac
 
 bookmark X moved to rev 0
 
   $ hg bookmarks
    * X                         0:f7b1eb17ad24
 
 look up bookmark
 
   $ hg log -r X
   changeset:   0:f7b1eb17ad24
   bookmark:    X
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     0
   
 
 second bookmark for rev 0, command should work even with ui.strict on
 
   $ hg --config ui.strict=1 bookmark X2 --config "$TESTHOOK"
   test-hook-bookmark: X2:   -> f7b1eb17ad24730a1651fccd46c43826d1bbc2ac
 
 bookmark rev -1 again
 
   $ hg bookmark -r null Y
 
 list bookmarks
 
   $ hg bookmarks
      X                         0:f7b1eb17ad24
    * X2                        0:f7b1eb17ad24
      Y                         -1:000000000000
+  $ hg log -T '{bookmarks % "{rev} {bookmark}\n"}'
+  0 X
+  0 X2
 
   $ echo b > b
   $ hg add b
   $ hg commit -m 1 --config "$TESTHOOK"
   test-hook-bookmark: X2:  f7b1eb17ad24730a1651fccd46c43826d1bbc2ac -> 925d80f479bb026b0fb3deb27503780b13f74123
 
   $ hg bookmarks -Tjson
   [
    {
     "active": false,
     "bookmark": "X",
     "node": "f7b1eb17ad24730a1651fccd46c43826d1bbc2ac",
     "rev": 0
    },
    {
     "active": true,
     "bookmark": "X2",
     "node": "925d80f479bb026b0fb3deb27503780b13f74123",
     "rev": 1
    },
    {
     "active": false,
     "bookmark": "Y",
     "node": "0000000000000000000000000000000000000000",
     "rev": -1
    }
   ]
 
 bookmarks revset
 
   $ hg log -r 'bookmark()'
   changeset:   0:f7b1eb17ad24
   bookmark:    X
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     0
   
   changeset:   1:925d80f479bb
   bookmark:    X2
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     1
   
   $ hg log -r 'bookmark(Y)'
   $ hg log -r 'bookmark(X2)'
   changeset:   1:925d80f479bb
   bookmark:    X2
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     1
   
   $ hg log -r 'bookmark("re:X")'
   changeset:   0:f7b1eb17ad24
   bookmark:    X
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     0
   
   changeset:   1:925d80f479bb
   bookmark:    X2
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     1
   
   $ hg log -r 'bookmark("literal:X")'
   changeset:   0:f7b1eb17ad24
   bookmark:    X
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     0
   
 
   $ hg log -r 'bookmark(unknown)'
   abort: bookmark 'unknown' does not exist!
   [255]
   $ hg log -r 'bookmark("literal:unknown")'
   abort: bookmark 'unknown' does not exist!
   [255]
   $ hg log -r 'bookmark("re:unknown")'
   abort: no bookmarks exist that match 'unknown'!
   [255]
   $ hg log -r 'present(bookmark("literal:unknown"))'
   $ hg log -r 'present(bookmark("re:unknown"))'
 
   $ hg help revsets | grep 'bookmark('
       "bookmark([name])"
 
 bookmarks X and X2 moved to rev 1, Y at rev -1
 
   $ hg bookmarks
      X                         0:f7b1eb17ad24
    * X2                        1:925d80f479bb
      Y                         -1:000000000000
 
 bookmark rev 0 again
 
   $ hg bookmark -r 0 Z
 
   $ hg update X
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   (activating bookmark X)
   $ echo c > c
   $ hg add c
   $ hg commit -m 2
   created new head
 
 bookmarks X moved to rev 2, Y at rev -1, Z at rev 0
 
   $ hg bookmarks
    * X                         2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         -1:000000000000
      Z                         0:f7b1eb17ad24
 
 rename nonexistent bookmark
 
   $ hg bookmark -m A B
   abort: bookmark 'A' does not exist
   [255]
 
 rename to existent bookmark
 
   $ hg bookmark -m X Y
   abort: bookmark 'Y' already exists (use -f to force)
   [255]
 
 force rename to existent bookmark
 
   $ hg bookmark -f -m X Y
 
 rename bookmark using .
 
   $ hg book rename-me
   $ hg book -m . renamed --config "$TESTHOOK"
   test-hook-bookmark: rename-me:  db815d6d32e69058eadefc8cffbad37675707975 -> 
   test-hook-bookmark: renamed:   -> db815d6d32e69058eadefc8cffbad37675707975
   $ hg bookmark
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
    * renamed                   2:db815d6d32e6
   $ hg up -q Y
   $ hg book -d renamed --config "$TESTHOOK"
   test-hook-bookmark: renamed:  db815d6d32e69058eadefc8cffbad37675707975 -> 
 
 rename bookmark using . with no active bookmark
 
   $ hg book rename-me
   $ hg book -i rename-me
   $ hg book -m . renamed
   abort: no active bookmark
   [255]
   $ hg up -q Y
   $ hg book -d rename-me
 
 delete bookmark using .
 
   $ hg book delete-me
   $ hg book -d .
   $ hg bookmark
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
   $ hg up -q Y
 
 delete bookmark using . with no active bookmark
 
   $ hg book delete-me
   $ hg book -i delete-me
   $ hg book -d .
   abort: no active bookmark
   [255]
   $ hg up -q Y
   $ hg book -d delete-me
 
 list bookmarks
 
   $ hg bookmark
      X2                        1:925d80f479bb
    * Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
 
 bookmarks from a revset
   $ hg bookmark -r '.^1' REVSET
   $ hg bookmark -r ':tip' TIP
   $ hg up -q TIP
   $ hg bookmarks
      REVSET                    0:f7b1eb17ad24
    * TIP                       2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
 
   $ hg bookmark -d REVSET
   $ hg bookmark -d TIP
 
 rename without new name or multiple names
 
   $ hg bookmark -m Y
   abort: new bookmark name required
   [255]
   $ hg bookmark -m Y Y2 Y3
   abort: only one new bookmark name allowed
   [255]
 
 delete without name
 
   $ hg bookmark -d
   abort: bookmark name required
   [255]
 
 delete nonexistent bookmark
 
   $ hg bookmark -d A
   abort: bookmark 'A' does not exist
   [255]
 
 bookmark name with spaces should be stripped
 
   $ hg bookmark ' x  y '
 
 list bookmarks
 
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
    * x  y                      2:db815d6d32e6
+  $ hg log -T '{bookmarks % "{rev} {bookmark}\n"}'
+  2 Y
+  2 x  y
+  1 X2
+  0 Z
 
 look up stripped bookmark name
 
   $ hg log -r '"x  y"'
   changeset:   2:db815d6d32e6
   bookmark:    Y
   bookmark:    x  y
   tag:         tip
   parent:      0:f7b1eb17ad24
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     2
   
 
 reject bookmark name with newline
 
   $ hg bookmark '
   > '
   abort: bookmark names cannot consist entirely of whitespace
   [255]
 
   $ hg bookmark -m Z '
   > '
   abort: bookmark names cannot consist entirely of whitespace
   [255]
 
 bookmark with reserved name
 
   $ hg bookmark tip
   abort: the name 'tip' is reserved
   [255]
 
   $ hg bookmark .
   abort: the name '.' is reserved
   [255]
 
   $ hg bookmark null
   abort: the name 'null' is reserved
   [255]
 
 
 bookmark with existing name
 
   $ hg bookmark X2
   abort: bookmark 'X2' already exists (use -f to force)
   [255]
 
   $ hg bookmark -m Y Z
   abort: bookmark 'Z' already exists (use -f to force)
   [255]
 
 bookmark with name of branch
 
   $ hg bookmark default
   abort: a bookmark cannot have the name of an existing branch
   [255]
 
   $ hg bookmark -m Y default
   abort: a bookmark cannot have the name of an existing branch
   [255]
 
 bookmark with integer name
 
   $ hg bookmark 10
   abort: cannot use an integer as a name
   [255]
 
 bookmark with a name that matches a node id
   $ hg bookmark 925d80f479bb db815d6d32e6 --config "$TESTHOOK"
   bookmark 925d80f479bb matches a changeset hash
   (did you leave a -r out of an 'hg bookmark' command?)
   bookmark db815d6d32e6 matches a changeset hash
   (did you leave a -r out of an 'hg bookmark' command?)
   test-hook-bookmark: 925d80f479bb:   -> db815d6d32e69058eadefc8cffbad37675707975
   test-hook-bookmark: db815d6d32e6:   -> db815d6d32e69058eadefc8cffbad37675707975
   $ hg bookmark -d 925d80f479bb
   $ hg bookmark -d db815d6d32e6
 
   $ cd ..
 
 bookmark with a name that matches an ambiguous node id
 
   $ hg init ambiguous
   $ cd ambiguous
   $ echo 0 > a
   $ hg ci -qAm 0
   $ for i in 1057 2857 4025; do
   >   hg up -q 0
   >   echo $i > a
   >   hg ci -qm $i
   > done
   $ hg up -q null
   $ hg log -r0: -T '{rev}:{node}\n'
   0:b4e73ffab476aa0ee32ed81ca51e07169844bc6a
   1:c56256a09cd28e5764f32e8e2810d0f01e2e357a
   2:c5623987d205cd6d9d8389bfc40fff9dbb670b48
   3:c562ddd9c94164376c20b86b0b4991636a3bf84f
 
   $ hg bookmark -r0 c562
   $ hg bookmarks
      c562                      0:b4e73ffab476
 
   $ cd ..
 
 incompatible options
 
   $ cd repo
 
   $ hg bookmark -m Y -d Z
   abort: --delete and --rename are incompatible
   [255]
 
   $ hg bookmark -r 1 -d Z
   abort: --rev is incompatible with --delete
   [255]
 
   $ hg bookmark -r 1 -m Z Y
   abort: --rev is incompatible with --rename
   [255]
 
 force bookmark with existing name
 
   $ hg bookmark -f X2 --config "$TESTHOOK"
   test-hook-bookmark: X2:  925d80f479bb026b0fb3deb27503780b13f74123 -> db815d6d32e69058eadefc8cffbad37675707975
 
 force bookmark back to where it was, should deactivate it
 
   $ hg bookmark -fr1 X2
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         0:f7b1eb17ad24
      x  y                      2:db815d6d32e6
 
 forward bookmark to descendant without --force
 
   $ hg bookmark Z
   moving bookmark 'Z' forward from f7b1eb17ad24
 
 list bookmarks
 
   $ hg bookmark
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         2:db815d6d32e6
      x  y                      2:db815d6d32e6
+  $ hg log -T '{bookmarks % "{rev} {bookmark}\n"}'
+  2 Y
+  2 Z
+  2 x  y
+  1 X2
 
 revision but no bookmark name
 
   $ hg bookmark -r .
   abort: bookmark name required
   [255]
 
 bookmark name with whitespace only
 
   $ hg bookmark ' '
   abort: bookmark names cannot consist entirely of whitespace
   [255]
 
   $ hg bookmark -m Y ' '
   abort: bookmark names cannot consist entirely of whitespace
   [255]
 
 invalid bookmark
 
   $ hg bookmark 'foo:bar'
   abort: ':' cannot be used in a name
   [255]
 
   $ hg bookmark 'foo
   > bar'
   abort: '\n' cannot be used in a name
   [255]
 
 the bookmark extension should be ignored now that it is part of core
 
   $ echo "[extensions]" >> $HGRCPATH
   $ echo "bookmarks=" >> $HGRCPATH
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
 test summary
 
   $ hg summary
   parent: 2:db815d6d32e6 tip
    2
   branch: default
   bookmarks: *Z Y x  y
   commit: (clean)
   update: 1 new changesets, 2 branch heads (merge)
   phases: 3 draft
 
 test id
 
   $ hg id
   db815d6d32e6 tip Y/Z/x  y
 
 test rollback
 
   $ echo foo > f1
   $ hg bookmark tmp-rollback
   $ hg ci -Amr
   adding f1
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         2:db815d6d32e6
    * tmp-rollback              3:2bf5cfec5864
      x  y                      2:db815d6d32e6
   $ hg rollback
   repository tip rolled back to revision 2 (undo commit)
   working directory now based on revision 2
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         2:db815d6d32e6
    * tmp-rollback              2:db815d6d32e6
      x  y                      2:db815d6d32e6
   $ hg bookmark -f Z -r 1
   $ hg rollback
   repository tip rolled back to revision 2 (undo bookmark)
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         2:db815d6d32e6
    * tmp-rollback              2:db815d6d32e6
      x  y                      2:db815d6d32e6
   $ hg bookmark -d tmp-rollback
 
 activate bookmark on working dir parent without --force
 
   $ hg bookmark --inactive Z
   $ hg bookmark Z
 
 test clone
 
   $ hg bookmark -r 2 -i @
   $ hg bookmark -r 2 -i a@
   $ hg bookmarks
      @                         2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         2:db815d6d32e6
      a@                        2:db815d6d32e6
      x  y                      2:db815d6d32e6
   $ hg clone . cloned-bookmarks
   updating to bookmark @
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R cloned-bookmarks bookmarks
    * @                         2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         2:db815d6d32e6
      a@                        2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
 test clone with pull protocol
 
   $ hg clone --pull . cloned-bookmarks-pull
   requesting all changes
   adding changesets
   adding manifests
   adding file changes
   added 3 changesets with 3 changes to 3 files (+1 heads)
   new changesets f7b1eb17ad24:db815d6d32e6
   updating to bookmark @
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R cloned-bookmarks-pull bookmarks
    * @                         2:db815d6d32e6
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         2:db815d6d32e6
      a@                        2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
 delete multiple bookmarks at once
 
   $ hg bookmark -d @ a@
 
 test clone with a bookmark named "default" (issue3677)
 
   $ hg bookmark -r 1 -f -i default
   $ hg clone . cloned-bookmark-default
   updating to branch default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R cloned-bookmark-default bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
      Z                         2:db815d6d32e6
      default                   1:925d80f479bb
      x  y                      2:db815d6d32e6
   $ hg -R cloned-bookmark-default parents -q
   2:db815d6d32e6
   $ hg bookmark -d default
 
 test clone with a specific revision
 
   $ hg clone -r 925d80 . cloned-bookmarks-rev
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 2 changes to 2 files
   new changesets f7b1eb17ad24:925d80f479bb
   updating to branch default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R cloned-bookmarks-rev bookmarks
      X2                        1:925d80f479bb
 
 test clone with update to a bookmark
 
   $ hg clone -u Z . ../cloned-bookmarks-update
   updating to branch default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R ../cloned-bookmarks-update bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         2:db815d6d32e6
      x  y                      2:db815d6d32e6
 
 create bundle with two heads
 
   $ hg clone . tobundle
   updating to branch default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo x > tobundle/x
   $ hg -R tobundle add tobundle/x
   $ hg -R tobundle commit -m'x'
   $ hg -R tobundle update -r -2
   0 files updated, 0 files merged, 1 files removed, 0 files unresolved
   $ echo y > tobundle/y
   $ hg -R tobundle branch test
   marked working directory as branch test
   (branches are permanent and global, did you want a bookmark?)
   $ hg -R tobundle add tobundle/y
   $ hg -R tobundle commit -m'y'
   $ hg -R tobundle bundle tobundle.hg
   searching for changes
   2 changesets found
   $ hg unbundle tobundle.hg
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 2 changes to 2 files (+1 heads)
   new changesets 125c9a1d6df6:9ba5f110a0b3
   (run 'hg heads' to see heads, 'hg merge' to merge)
 
 update to active bookmark if it's not the parent
 
 (it is known issue that fsmonitor can't handle nested repositories. In
 this test scenario, cloned-bookmark-default and tobundle exist in the
 working directory of current repository)
 
   $ hg summary
   parent: 2:db815d6d32e6 
    2
   branch: default
   bookmarks: *Z Y x  y
   commit: 1 added, 1 unknown (new branch head) (no-fsmonitor !)
   commit: 1 added, * unknown (new branch head) (glob) (fsmonitor !)
   update: 2 new changesets (update)
   phases: 5 draft
   $ hg update
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   updating bookmark Z
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         2:db815d6d32e6
    * Z                         3:125c9a1d6df6
      x  y                      2:db815d6d32e6
 
 pull --update works the same as pull && update
 
   $ hg bookmark -r3 Y
   moving bookmark 'Y' forward from db815d6d32e6
   $ cp -R ../cloned-bookmarks-update ../cloned-bookmarks-manual-update
   $ cp -R ../cloned-bookmarks-update ../cloned-bookmarks-manual-update-with-divergence
 
 (manual version)
 
   $ hg -R ../cloned-bookmarks-manual-update update Y
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   (activating bookmark Y)
   $ hg -R ../cloned-bookmarks-manual-update pull .
   pulling from .
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 2 changes to 2 files (+1 heads)
   updating bookmark Y
   updating bookmark Z
   new changesets 125c9a1d6df6:9ba5f110a0b3
   (run 'hg heads' to see heads, 'hg merge' to merge)
 
 (# tests strange but with --date crashing when bookmark have to move)
 
   $ hg -R ../cloned-bookmarks-manual-update update -d 1986
   abort: revision matching date not found
   [255]
   $ hg -R ../cloned-bookmarks-manual-update update
   updating to active bookmark Y
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
 (all in one version)
 
   $ hg -R ../cloned-bookmarks-update update Y
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   (activating bookmark Y)
   $ hg -R ../cloned-bookmarks-update pull --update .
   pulling from .
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 2 changes to 2 files (+1 heads)
   updating bookmark Y
   updating bookmark Z
   new changesets 125c9a1d6df6:9ba5f110a0b3
   updating to active bookmark Y
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
 We warn about divergent during bare update to the active bookmark
 
   $ hg -R ../cloned-bookmarks-manual-update-with-divergence update Y
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   (activating bookmark Y)
   $ hg -R ../cloned-bookmarks-manual-update-with-divergence bookmarks -r X2 Y@1
   $ hg -R ../cloned-bookmarks-manual-update-with-divergence bookmarks
      X2                        1:925d80f479bb
    * Y                         2:db815d6d32e6
      Y@1                       1:925d80f479bb
      Z                         2:db815d6d32e6
      x  y                      2:db815d6d32e6
   $ hg -R ../cloned-bookmarks-manual-update-with-divergence pull
   pulling from $TESTTMP/repo
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 2 changes to 2 files (+1 heads)
   updating bookmark Y
   updating bookmark Z
   new changesets 125c9a1d6df6:9ba5f110a0b3
   (run 'hg heads' to see heads, 'hg merge' to merge)
   $ hg -R ../cloned-bookmarks-manual-update-with-divergence update
   updating to active bookmark Y
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   1 other divergent bookmarks for "Y"
 
 test wrongly formated bookmark
 
   $ echo '' >> .hg/bookmarks
   $ hg bookmarks
      X2                        1:925d80f479bb
      Y                         3:125c9a1d6df6
    * Z                         3:125c9a1d6df6
      x  y                      2:db815d6d32e6
   $ echo "Ican'thasformatedlines" >> .hg/bookmarks
   $ hg bookmarks
   malformed line in .hg/bookmarks: "Ican'thasformatedlines"
      X2                        1:925d80f479bb
      Y                         3:125c9a1d6df6
    * Z                         3:125c9a1d6df6
      x  y                      2:db815d6d32e6
 
 test missing revisions
 
   $ echo "925d80f479b925d80f479bc925d80f479bccabab z" > .hg/bookmarks
   $ hg book
   no bookmarks set
 
 test stripping a non-checked-out but bookmarked revision
 
   $ hg log --graph
   o  changeset:   4:9ba5f110a0b3
   |  branch:      test
   |  tag:         tip
   |  parent:      2:db815d6d32e6
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     y
   |
   | @  changeset:   3:125c9a1d6df6
   |/   user:        test
   |    date:        Thu Jan 01 00:00:00 1970 +0000
   |    summary:     x
   |
   o  changeset:   2:db815d6d32e6
   |  parent:      0:f7b1eb17ad24
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     2
   |
   | o  changeset:   1:925d80f479bb
   |/   user:        test
   |    date:        Thu Jan 01 00:00:00 1970 +0000
   |    summary:     1
   |
   o  changeset:   0:f7b1eb17ad24
      user:        test
      date:        Thu Jan 01 00:00:00 1970 +0000
      summary:     0
   
   $ hg book should-end-on-two
   $ hg co --clean 4
   1 files updated, 0 files merged, 1 files removed, 0 files unresolved
   (leaving bookmark should-end-on-two)
   $ hg book four
   $ hg --config extensions.mq= strip 3
   saved backup bundle to * (glob)
 should-end-on-two should end up pointing to revision 2, as that's the
 tipmost surviving ancestor of the stripped revision.
   $ hg log --graph
   @  changeset:   3:9ba5f110a0b3
   |  branch:      test
   |  bookmark:    four
   |  tag:         tip
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     y
   |
   o  changeset:   2:db815d6d32e6
   |  bookmark:    should-end-on-two
   |  parent:      0:f7b1eb17ad24
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     2
   |
   | o  changeset:   1:925d80f479bb
   |/   user:        test
   |    date:        Thu Jan 01 00:00:00 1970 +0000
   |    summary:     1
   |
   o  changeset:   0:f7b1eb17ad24
      user:        test
      date:        Thu Jan 01 00:00:00 1970 +0000
      summary:     0
   
 
 no-op update doesn't deactivate bookmarks
 
 (it is known issue that fsmonitor can't handle nested repositories. In
 this test scenario, cloned-bookmark-default and tobundle exist in the
 working directory of current repository)
 
   $ hg bookmarks
    * four                      3:9ba5f110a0b3
      should-end-on-two         2:db815d6d32e6
   $ hg up four
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg up
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg sum
   parent: 3:9ba5f110a0b3 tip
    y
   branch: test
   bookmarks: *four
   commit: 2 unknown (clean) (no-fsmonitor !)
   commit: * unknown (clean) (glob) (fsmonitor !)
   update: (current)
   phases: 4 draft
 
 test clearing divergent bookmarks of linear ancestors
 
   $ hg bookmark Z -r 0
   $ hg bookmark Z@1 -r 1
   $ hg bookmark Z@2 -r 2
   $ hg bookmark Z@3 -r 3
   $ hg book
      Z                         0:f7b1eb17ad24
      Z@1                       1:925d80f479bb
      Z@2                       2:db815d6d32e6
      Z@3                       3:9ba5f110a0b3
    * four                      3:9ba5f110a0b3
      should-end-on-two         2:db815d6d32e6
   $ hg bookmark Z
   moving bookmark 'Z' forward from f7b1eb17ad24
   $ hg book
    * Z                         3:9ba5f110a0b3
      Z@1                       1:925d80f479bb
      four                      3:9ba5f110a0b3
      should-end-on-two         2:db815d6d32e6
 
 test clearing only a single divergent bookmark across branches
 
   $ hg book foo -r 1
   $ hg book foo@1 -r 0
   $ hg book foo@2 -r 2
   $ hg book foo@3 -r 3
   $ hg book foo -r foo@3
   $ hg book
    * Z                         3:9ba5f110a0b3
      Z@1                       1:925d80f479bb
      foo                       3:9ba5f110a0b3
      foo@1                     0:f7b1eb17ad24
      foo@2                     2:db815d6d32e6
      four                      3:9ba5f110a0b3
      should-end-on-two         2:db815d6d32e6
 
 pull --update works the same as pull && update (case #2)
 
 It is assumed that "hg pull" itself doesn't update current active
 bookmark ('Y' in tests below).
 
   $ hg pull -q ../cloned-bookmarks-update
   divergent bookmark Z stored as Z@2
 
 (pulling revision on another named branch with --update updates
 neither the working directory nor current active bookmark: "no-op"
 case)
 
   $ echo yy >> y
   $ hg commit -m yy
 
   $ hg -R ../cloned-bookmarks-update bookmarks | grep ' Y '
    * Y                         3:125c9a1d6df6
   $ hg -R ../cloned-bookmarks-update pull . --update
   pulling from .
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   divergent bookmark Z stored as Z@default
   adding remote bookmark foo
   adding remote bookmark four
   adding remote bookmark should-end-on-two
   new changesets 5fb12f0f2d51
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -R ../cloned-bookmarks-update parents -T "{rev}:{node|short}\n"
   3:125c9a1d6df6
   $ hg -R ../cloned-bookmarks-update bookmarks | grep ' Y '
    * Y                         3:125c9a1d6df6
 
 (pulling revision on current named/topological branch with --update
 updates the working directory and current active bookmark)
 
   $ hg update -C -q 125c9a1d6df6
   $ echo xx >> x
   $ hg commit -m xx
 
   $ hg -R ../cloned-bookmarks-update bookmarks | grep ' Y '
    * Y                         3:125c9a1d6df6
   $ hg -R ../cloned-bookmarks-update pull . --update
   pulling from .
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   divergent bookmark Z stored as Z@default
   new changesets 81dcce76aa0b
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   updating bookmark Y
   $ hg -R ../cloned-bookmarks-update parents -T "{rev}:{node|short}\n"
   6:81dcce76aa0b
   $ hg -R ../cloned-bookmarks-update bookmarks | grep ' Y '
    * Y                         6:81dcce76aa0b
 
   $ cd ..
 
 ensure changelog is written before bookmarks
   $ hg init orderrepo
   $ cd orderrepo
   $ touch a
   $ hg commit -Aqm one
   $ hg book mybook
   $ echo a > a
 
   $ cat > $TESTTMP/pausefinalize.py <<EOF
   > from __future__ import absolute_import
   > import os
   > import time
   > from mercurial import extensions, localrepo
   > def transaction(orig, self, desc, report=None):
   >    tr = orig(self, desc, report)
   >    def sleep(*args, **kwargs):
   >        retry = 20
   >        while retry > 0 and not os.path.exists(b"$TESTTMP/unpause"):
   >            retry -= 1
   >            time.sleep(0.5)
   >        if os.path.exists(b"$TESTTMP/unpause"):
   >            os.remove(b"$TESTTMP/unpause")
   >    # It is important that this finalizer start with 'a', so it runs before
   >    # the changelog finalizer appends to the changelog.
   >    tr.addfinalize(b'a-sleep', sleep)
   >    return tr
   > 
   > def extsetup(ui):
   >    # This extension inserts an artifical pause during the transaction
   >    # finalizer, so we can run commands mid-transaction-close.
   >    extensions.wrapfunction(localrepo.localrepository, 'transaction',
   >                            transaction)
   > EOF
   $ hg commit -qm two --config extensions.pausefinalize=$TESTTMP/pausefinalize.py &
   $ sleep 2
   $ hg log -r .
   changeset:   0:867bc5792c8c
   bookmark:    mybook
   tag:         tip
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     one
   
   $ hg bookmarks
    * mybook                    0:867bc5792c8c
   $ touch $TESTTMP/unpause
 
   $ cd ..
 
 check whether HG_PENDING makes pending changes only in related
 repositories visible to an external hook.
 
 (emulate a transaction running concurrently by copied
 .hg/bookmarks.pending in subsequent test)
 
   $ cat > $TESTTMP/savepending.sh <<EOF
   > cp .hg/bookmarks.pending .hg/bookmarks.pending.saved
   > exit 1 # to avoid adding new bookmark for subsequent tests
   > EOF
 
   $ hg init unrelated
   $ cd unrelated
   $ echo a > a
   $ hg add a
   $ hg commit -m '#0'
   $ hg --config hooks.pretxnclose="sh $TESTTMP/savepending.sh" bookmarks INVISIBLE
   transaction abort!
   rollback completed
   abort: pretxnclose hook exited with status 1
   [255]
   $ cp .hg/bookmarks.pending.saved .hg/bookmarks.pending
 
 (check visible bookmarks while transaction running in repo)
 
   $ cat > $TESTTMP/checkpending.sh <<EOF
   > echo "@repo"
   > hg -R "$TESTTMP/repo" bookmarks
   > echo "@unrelated"
   > hg -R "$TESTTMP/unrelated" bookmarks
   > exit 1 # to avoid adding new bookmark for subsequent tests
   > EOF
 
   $ cd ../repo
   $ hg --config hooks.pretxnclose="sh $TESTTMP/checkpending.sh" bookmarks NEW
   @repo
    * NEW                       6:81dcce76aa0b
      X2                        1:925d80f479bb
      Y                         4:125c9a1d6df6
      Z                         5:5fb12f0f2d51
      Z@1                       1:925d80f479bb
      Z@2                       4:125c9a1d6df6
      foo                       3:9ba5f110a0b3
      foo@1                     0:f7b1eb17ad24
      foo@2                     2:db815d6d32e6
      four                      3:9ba5f110a0b3
      should-end-on-two         2:db815d6d32e6
      x  y                      2:db815d6d32e6
   @unrelated
   no bookmarks set
   transaction abort!
   rollback completed
   abort: pretxnclose hook exited with status 1
   [255]
 
 Check pretxnclose-bookmark can abort a transaction
 --------------------------------------------------
 
 add hooks:
 
 * to prevent NEW bookmark on a non-public changeset
 * to prevent non-forward move of NEW bookmark
 
   $ cat << EOF >> .hg/hgrc
   > [hooks]
   > pretxnclose-bookmark.force-public  = sh -c "(echo \$HG_BOOKMARK| grep -v NEW > /dev/null) || [ -z \"\$HG_NODE\" ] || (hg log -r \"\$HG_NODE\" -T '{phase}' | grep public > /dev/null)"
   > pretxnclose-bookmark.force-forward = sh -c "(echo \$HG_BOOKMARK| grep -v NEW > /dev/null) || [ -z \"\$HG_NODE\" ] || (hg log -r \"max(\$HG_OLDNODE::\$HG_NODE)\" -T 'MATCH' | grep MATCH > /dev/null)"
   > EOF
 
   $ hg log -G -T phases
   @  changeset:   6:81dcce76aa0b
   |  tag:         tip
   |  phase:       draft
   |  parent:      4:125c9a1d6df6
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     xx
   |
   | o  changeset:   5:5fb12f0f2d51
   | |  branch:      test
   | |  bookmark:    Z
   | |  phase:       draft
   | |  parent:      3:9ba5f110a0b3
   | |  user:        test
   | |  date:        Thu Jan 01 00:00:00 1970 +0000
   | |  summary:     yy
   | |
   o |  changeset:   4:125c9a1d6df6
   | |  bookmark:    Y
   | |  bookmark:    Z@2
   | |  phase:       public
   | |  parent:      2:db815d6d32e6
   | |  user:        test
   | |  date:        Thu Jan 01 00:00:00 1970 +0000
   | |  summary:     x
   | |
   | o  changeset:   3:9ba5f110a0b3
   |/   branch:      test
   |    bookmark:    foo
   |    bookmark:    four
   |    phase:       public
   |    user:        test
   |    date:        Thu Jan 01 00:00:00 1970 +0000
   |    summary:     y
   |
   o  changeset:   2:db815d6d32e6
   |  bookmark:    foo@2
   |  bookmark:    should-end-on-two
   |  bookmark:    x  y
   |  phase:       public
   |  parent:      0:f7b1eb17ad24
   |  user:        test
   |  date:        Thu Jan 01 00:00:00 1970 +0000
   |  summary:     2
   |
   | o  changeset:   1:925d80f479bb
   |/   bookmark:    X2
   |    bookmark:    Z@1
   |    phase:       public
   |    user:        test
   |    date:        Thu Jan 01 00:00:00 1970 +0000
   |    summary:     1
   |
   o  changeset:   0:f7b1eb17ad24
      bookmark:    foo@1
      phase:       public
      user:        test
      date:        Thu Jan 01 00:00:00 1970 +0000
      summary:     0
   
 
 attempt to create on a default changeset
 
   $ hg bookmark -r 81dcce76aa0b NEW
   transaction abort!
   rollback completed
   abort: pretxnclose-bookmark.force-public hook exited with status 1
   [255]
 
 create on a public changeset
 
   $ hg bookmark -r 9ba5f110a0b3 NEW
 
 move to the other branch
 
   $ hg bookmark -f -r 125c9a1d6df6 NEW
   transaction abort!
   rollback completed
   abort: pretxnclose-bookmark.force-forward hook exited with status 1
   [255]