keyword: suppress keyword expansion while 'hg backout' for internal merge

Before this patch, 'hg backout' may cause unexpected conflict, if 'hg
backout'-ed changes are located near lines in which keywords are
embedded, because keywords are substituted with other strings in the
working directory.

This patch suppresses keyword expansion while 'hg backout' for
internal merge by adding 'backout' to 'restricted' command list like
'merge'.

hgext/keyword.py

@@ -1,736 +1,736 b''
 # keyword.py - $Keyword$ expansion for Mercurial
 #
 # Copyright 2007-2012 Christian Ebert <[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.
 #
 # $Id$
 #
 # Keyword expansion hack against the grain of a Distributed SCM
 #
 # There are many good reasons why this is not needed in a distributed
 # SCM, still it may be useful in very small projects based on single
 # files (like LaTeX packages), that are mostly addressed to an
 # audience not running a version control system.
 #
 # For in-depth discussion refer to
 # <http://mercurial.selenic.com/wiki/KeywordPlan>.
 #
 # Keyword expansion is based on Mercurial's changeset template mappings.
 #
 # Binary files are not touched.
 #
 # Files to act upon/ignore are specified in the [keyword] section.
 # Customized keyword template mappings in the [keywordmaps] section.
 #
 # Run "hg help keyword" and "hg kwdemo" to get info on configuration.
 
 '''expand keywords in tracked files
 
 This extension expands RCS/CVS-like or self-customized $Keywords$ in
 tracked text files selected by your configuration.
 
 Keywords are only expanded in local repositories and not stored in the
 change history. The mechanism can be regarded as a convenience for the
 current user or for archive distribution.
 
 Keywords expand to the changeset data pertaining to the latest change
 relative to the working directory parent of each file.
 
 Configuration is done in the [keyword], [keywordset] and [keywordmaps]
 sections of hgrc files.
 
 Example::
 
     [keyword]
     # expand keywords in every python file except those matching "x*"
     **.py =
     x*    = ignore
 
     [keywordset]
     # prefer svn- over cvs-like default keywordmaps
     svn = True
 
 .. note::
 
    The more specific you are in your filename patterns the less you
    lose speed in huge repositories.
 
 For [keywordmaps] template mapping and expansion demonstration and
 control run :hg:`kwdemo`. See :hg:`help templates` for a list of
 available templates and filters.
 
 Three additional date template filters are provided:
 
 :``utcdate``:    "2006/09/18 15:13:13"
 :``svnutcdate``: "2006-09-18 15:13:13Z"
 :``svnisodate``: "2006-09-18 08:13:13 -700 (Mon, 18 Sep 2006)"
 
 The default template mappings (view with :hg:`kwdemo -d`) can be
 replaced with customized keywords and templates. Again, run
 :hg:`kwdemo` to control the results of your configuration changes.
 
 Before changing/disabling active keywords, you must run :hg:`kwshrink`
 to avoid storing expanded keywords in the change history.
 
 To force expansion after enabling it, or a configuration change, run
 :hg:`kwexpand`.
 
 Expansions spanning more than one line and incremental expansions,
 like CVS' $Log$, are not supported. A keyword template map "Log =
 {desc}" expands to the first line of the changeset description.
 '''
 
 from mercurial import commands, context, cmdutil, dispatch, filelog, extensions
 from mercurial import localrepo, match, patch, templatefilters, templater, util
 from mercurial import scmutil, pathutil
 from mercurial.hgweb import webcommands
 from mercurial.i18n import _
 import os, re, shutil, tempfile
 
 commands.optionalrepo += ' kwdemo'
 commands.inferrepo += ' kwexpand kwfiles kwshrink'
 
 cmdtable = {}
 command = cmdutil.command(cmdtable)
 testedwith = 'internal'
 
 # hg commands that do not act on keywords
 nokwcommands = ('add addremove annotate bundle export grep incoming init log'
                 ' outgoing push tip verify convert email glog')
 
 # hg commands that trigger expansion only when writing to working dir,
 # not when reading filelog, and unexpand when reading from working dir
 restricted = ('merge kwexpand kwshrink record qrecord resolve transplant'
-              ' unshelve rebase graft')
+              ' unshelve rebase graft backout')
 
 # names of extensions using dorecord
 recordextensions = 'record'
 
 colortable = {
     'kwfiles.enabled': 'green bold',
     'kwfiles.deleted': 'cyan bold underline',
     'kwfiles.enabledunknown': 'green',
     'kwfiles.ignored': 'bold',
     'kwfiles.ignoredunknown': 'none'
 }
 
 # date like in cvs' $Date
 def utcdate(text):
     ''':utcdate: Date. Returns a UTC-date in this format: "2009/08/18 11:00:13".
     '''
     return util.datestr((util.parsedate(text)[0], 0), '%Y/%m/%d %H:%M:%S')
 # date like in svn's $Date
 def svnisodate(text):
     ''':svnisodate: Date. Returns a date in this format: "2009-08-18 13:00:13
     +0200 (Tue, 18 Aug 2009)".
     '''
     return util.datestr(text, '%Y-%m-%d %H:%M:%S %1%2 (%a, %d %b %Y)')
 # date like in svn's $Id
 def svnutcdate(text):
     ''':svnutcdate: Date. Returns a UTC-date in this format: "2009-08-18
     11:00:13Z".
     '''
     return util.datestr((util.parsedate(text)[0], 0), '%Y-%m-%d %H:%M:%SZ')
 
 templatefilters.filters.update({'utcdate': utcdate,
                                 'svnisodate': svnisodate,
                                 'svnutcdate': svnutcdate})
 
 # make keyword tools accessible
 kwtools = {'templater': None, 'hgcmd': ''}
 
 def _defaultkwmaps(ui):
     '''Returns default keywordmaps according to keywordset configuration.'''
     templates = {
         'Revision': '{node|short}',
         'Author': '{author|user}',
     }
     kwsets = ({
         'Date': '{date|utcdate}',
         'RCSfile': '{file|basename},v',
         'RCSFile': '{file|basename},v', # kept for backwards compatibility
                                         # with hg-keyword
         'Source': '{root}/{file},v',
         'Id': '{file|basename},v {node|short} {date|utcdate} {author|user}',
         'Header': '{root}/{file},v {node|short} {date|utcdate} {author|user}',
     }, {
         'Date': '{date|svnisodate}',
         'Id': '{file|basename},v {node|short} {date|svnutcdate} {author|user}',
         'LastChangedRevision': '{node|short}',
         'LastChangedBy': '{author|user}',
         'LastChangedDate': '{date|svnisodate}',
     })
     templates.update(kwsets[ui.configbool('keywordset', 'svn')])
     return templates
 
 def _shrinktext(text, subfunc):
     '''Helper for keyword expansion removal in text.
     Depending on subfunc also returns number of substitutions.'''
     return subfunc(r'$\1$', text)
 
 def _preselect(wstatus, changed):
     '''Retrieves modified and added files from a working directory state
     and returns the subset of each contained in given changed files
     retrieved from a change context.'''
     modified, added = wstatus[:2]
     modified = [f for f in modified if f in changed]
     added = [f for f in added if f in changed]
     return modified, added
 
 
 class kwtemplater(object):
     '''
     Sets up keyword templates, corresponding keyword regex, and
     provides keyword substitution functions.
     '''
 
     def __init__(self, ui, repo, inc, exc):
         self.ui = ui
         self.repo = repo
         self.match = match.match(repo.root, '', [], inc, exc)
         self.restrict = kwtools['hgcmd'] in restricted.split()
         self.postcommit = False
 
         kwmaps = self.ui.configitems('keywordmaps')
         if kwmaps: # override default templates
             self.templates = dict((k, templater.parsestring(v, False))
                                   for k, v in kwmaps)
         else:
             self.templates = _defaultkwmaps(self.ui)
 
     @util.propertycache
     def escape(self):
         '''Returns bar-separated and escaped keywords.'''
         return '|'.join(map(re.escape, self.templates.keys()))
 
     @util.propertycache
     def rekw(self):
         '''Returns regex for unexpanded keywords.'''
         return re.compile(r'\$(%s)\$' % self.escape)
 
     @util.propertycache
     def rekwexp(self):
         '''Returns regex for expanded keywords.'''
         return re.compile(r'\$(%s): [^$\n\r]*? \$' % self.escape)
 
     def substitute(self, data, path, ctx, subfunc):
         '''Replaces keywords in data with expanded template.'''
         def kwsub(mobj):
             kw = mobj.group(1)
             ct = cmdutil.changeset_templater(self.ui, self.repo, False, None,
                                              self.templates[kw], '', False)
             self.ui.pushbuffer()
             ct.show(ctx, root=self.repo.root, file=path)
             ekw = templatefilters.firstline(self.ui.popbuffer())
             return '$%s: %s $' % (kw, ekw)
         return subfunc(kwsub, data)
 
     def linkctx(self, path, fileid):
         '''Similar to filelog.linkrev, but returns a changectx.'''
         return self.repo.filectx(path, fileid=fileid).changectx()
 
     def expand(self, path, node, data):
         '''Returns data with keywords expanded.'''
         if not self.restrict and self.match(path) and not util.binary(data):
             ctx = self.linkctx(path, node)
             return self.substitute(data, path, ctx, self.rekw.sub)
         return data
 
     def iskwfile(self, cand, ctx):
         '''Returns subset of candidates which are configured for keyword
         expansion but are not symbolic links.'''
         return [f for f in cand if self.match(f) and 'l' not in ctx.flags(f)]
 
     def overwrite(self, ctx, candidates, lookup, expand, rekw=False):
         '''Overwrites selected files expanding/shrinking keywords.'''
         if self.restrict or lookup or self.postcommit: # exclude kw_copy
             candidates = self.iskwfile(candidates, ctx)
         if not candidates:
             return
         kwcmd = self.restrict and lookup # kwexpand/kwshrink
         if self.restrict or expand and lookup:
             mf = ctx.manifest()
         if self.restrict or rekw:
             re_kw = self.rekw
         else:
             re_kw = self.rekwexp
         if expand:
             msg = _('overwriting %s expanding keywords\n')
         else:
             msg = _('overwriting %s shrinking keywords\n')
         for f in candidates:
             if self.restrict:
                 data = self.repo.file(f).read(mf[f])
             else:
                 data = self.repo.wread(f)
             if util.binary(data):
                 continue
             if expand:
                 if lookup:
                     ctx = self.linkctx(f, mf[f])
                 data, found = self.substitute(data, f, ctx, re_kw.subn)
             elif self.restrict:
                 found = re_kw.search(data)
             else:
                 data, found = _shrinktext(data, re_kw.subn)
             if found:
                 self.ui.note(msg % f)
                 fp = self.repo.wopener(f, "wb", atomictemp=True)
                 fp.write(data)
                 fp.close()
                 if kwcmd:
                     self.repo.dirstate.normal(f)
                 elif self.postcommit:
                     self.repo.dirstate.normallookup(f)
 
     def shrink(self, fname, text):
         '''Returns text with all keyword substitutions removed.'''
         if self.match(fname) and not util.binary(text):
             return _shrinktext(text, self.rekwexp.sub)
         return text
 
     def shrinklines(self, fname, lines):
         '''Returns lines with keyword substitutions removed.'''
         if self.match(fname):
             text = ''.join(lines)
             if not util.binary(text):
                 return _shrinktext(text, self.rekwexp.sub).splitlines(True)
         return lines
 
     def wread(self, fname, data):
         '''If in restricted mode returns data read from wdir with
         keyword substitutions removed.'''
         if self.restrict:
             return self.shrink(fname, data)
         return data
 
 class kwfilelog(filelog.filelog):
     '''
     Subclass of filelog to hook into its read, add, cmp methods.
     Keywords are "stored" unexpanded, and processed on reading.
     '''
     def __init__(self, opener, kwt, path):
         super(kwfilelog, self).__init__(opener, path)
         self.kwt = kwt
         self.path = path
 
     def read(self, node):
         '''Expands keywords when reading filelog.'''
         data = super(kwfilelog, self).read(node)
         if self.renamed(node):
             return data
         return self.kwt.expand(self.path, node, data)
 
     def add(self, text, meta, tr, link, p1=None, p2=None):
         '''Removes keyword substitutions when adding to filelog.'''
         text = self.kwt.shrink(self.path, text)
         return super(kwfilelog, self).add(text, meta, tr, link, p1, p2)
 
     def cmp(self, node, text):
         '''Removes keyword substitutions for comparison.'''
         text = self.kwt.shrink(self.path, text)
         return super(kwfilelog, self).cmp(node, text)
 
 def _status(ui, repo, wctx, kwt, *pats, **opts):
     '''Bails out if [keyword] configuration is not active.
     Returns status of working directory.'''
     if kwt:
         return repo.status(match=scmutil.match(wctx, pats, opts), clean=True,
                            unknown=opts.get('unknown') or opts.get('all'))
     if ui.configitems('keyword'):
         raise util.Abort(_('[keyword] patterns cannot match'))
     raise util.Abort(_('no [keyword] patterns configured'))
 
 def _kwfwrite(ui, repo, expand, *pats, **opts):
     '''Selects files and passes them to kwtemplater.overwrite.'''
     wctx = repo[None]
     if len(wctx.parents()) > 1:
         raise util.Abort(_('outstanding uncommitted merge'))
     kwt = kwtools['templater']
     wlock = repo.wlock()
     try:
         status = _status(ui, repo, wctx, kwt, *pats, **opts)
         modified, added, removed, deleted, unknown, ignored, clean = status
         if modified or added or removed or deleted:
             raise util.Abort(_('outstanding uncommitted changes'))
         kwt.overwrite(wctx, clean, True, expand)
     finally:
         wlock.release()
 
 @command('kwdemo',
          [('d', 'default', None, _('show default keyword template maps')),
           ('f', 'rcfile', '',
            _('read maps from rcfile'), _('FILE'))],
          _('hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP]...'))
 def demo(ui, repo, *args, **opts):
     '''print [keywordmaps] configuration and an expansion example
 
     Show current, custom, or default keyword template maps and their
     expansions.
 
     Extend the current configuration by specifying maps as arguments
     and using -f/--rcfile to source an external hgrc file.
 
     Use -d/--default to disable current configuration.
 
     See :hg:`help templates` for information on templates and filters.
     '''
     def demoitems(section, items):
         ui.write('[%s]\n' % section)
         for k, v in sorted(items):
             ui.write('%s = %s\n' % (k, v))
 
     fn = 'demo.txt'
     tmpdir = tempfile.mkdtemp('', 'kwdemo.')
     ui.note(_('creating temporary repository at %s\n') % tmpdir)
     repo = localrepo.localrepository(repo.baseui, tmpdir, True)
     ui.setconfig('keyword', fn, '', 'keyword')
     svn = ui.configbool('keywordset', 'svn')
     # explicitly set keywordset for demo output
     ui.setconfig('keywordset', 'svn', svn, 'keyword')
 
     uikwmaps = ui.configitems('keywordmaps')
     if args or opts.get('rcfile'):
         ui.status(_('\n\tconfiguration using custom keyword template maps\n'))
         if uikwmaps:
             ui.status(_('\textending current template maps\n'))
         if opts.get('default') or not uikwmaps:
             if svn:
                 ui.status(_('\toverriding default svn keywordset\n'))
             else:
                 ui.status(_('\toverriding default cvs keywordset\n'))
         if opts.get('rcfile'):
             ui.readconfig(opts.get('rcfile'))
         if args:
             # simulate hgrc parsing
             rcmaps = ['[keywordmaps]\n'] + [a + '\n' for a in args]
             fp = repo.opener('hgrc', 'w')
             fp.writelines(rcmaps)
             fp.close()
             ui.readconfig(repo.join('hgrc'))
         kwmaps = dict(ui.configitems('keywordmaps'))
     elif opts.get('default'):
         if svn:
             ui.status(_('\n\tconfiguration using default svn keywordset\n'))
         else:
             ui.status(_('\n\tconfiguration using default cvs keywordset\n'))
         kwmaps = _defaultkwmaps(ui)
         if uikwmaps:
             ui.status(_('\tdisabling current template maps\n'))
             for k, v in kwmaps.iteritems():
                 ui.setconfig('keywordmaps', k, v, 'keyword')
     else:
         ui.status(_('\n\tconfiguration using current keyword template maps\n'))
         if uikwmaps:
             kwmaps = dict(uikwmaps)
         else:
             kwmaps = _defaultkwmaps(ui)
 
     uisetup(ui)
     reposetup(ui, repo)
     ui.write('[extensions]\nkeyword =\n')
     demoitems('keyword', ui.configitems('keyword'))
     demoitems('keywordset', ui.configitems('keywordset'))
     demoitems('keywordmaps', kwmaps.iteritems())
     keywords = '$' + '$\n$'.join(sorted(kwmaps.keys())) + '$\n'
     repo.wopener.write(fn, keywords)
     repo[None].add([fn])
     ui.note(_('\nkeywords written to %s:\n') % fn)
     ui.note(keywords)
     wlock = repo.wlock()
     try:
         repo.dirstate.setbranch('demobranch')
     finally:
         wlock.release()
     for name, cmd in ui.configitems('hooks'):
         if name.split('.', 1)[0].find('commit') > -1:
             repo.ui.setconfig('hooks', name, '', 'keyword')
     msg = _('hg keyword configuration and expansion example')
     ui.note(("hg ci -m '%s'\n" % msg))
     repo.commit(text=msg)
     ui.status(_('\n\tkeywords expanded\n'))
     ui.write(repo.wread(fn))
     shutil.rmtree(tmpdir, ignore_errors=True)
 
 @command('kwexpand', commands.walkopts, _('hg kwexpand [OPTION]... [FILE]...'))
 def expand(ui, repo, *pats, **opts):
     '''expand keywords in the working directory
 
     Run after (re)enabling keyword expansion.
 
     kwexpand refuses to run if given files contain local changes.
     '''
     # 3rd argument sets expansion to True
     _kwfwrite(ui, repo, True, *pats, **opts)
 
 @command('kwfiles',
          [('A', 'all', None, _('show keyword status flags of all files')),
           ('i', 'ignore', None, _('show files excluded from expansion')),
           ('u', 'unknown', None, _('only show unknown (not tracked) files')),
          ] + commands.walkopts,
          _('hg kwfiles [OPTION]... [FILE]...'))
 def files(ui, repo, *pats, **opts):
     '''show files configured for keyword expansion
 
     List which files in the working directory are matched by the
     [keyword] configuration patterns.
 
     Useful to prevent inadvertent keyword expansion and to speed up
     execution by including only files that are actual candidates for
     expansion.
 
     See :hg:`help keyword` on how to construct patterns both for
     inclusion and exclusion of files.
 
     With -A/--all and -v/--verbose the codes used to show the status
     of files are::
 
       K = keyword expansion candidate
       k = keyword expansion candidate (not tracked)
       I = ignored
       i = ignored (not tracked)
     '''
     kwt = kwtools['templater']
     wctx = repo[None]
     status = _status(ui, repo, wctx, kwt, *pats, **opts)
     cwd = pats and repo.getcwd() or ''
     modified, added, removed, deleted, unknown, ignored, clean = status
     files = []
     if not opts.get('unknown') or opts.get('all'):
         files = sorted(modified + added + clean)
     kwfiles = kwt.iskwfile(files, wctx)
     kwdeleted = kwt.iskwfile(deleted, wctx)
     kwunknown = kwt.iskwfile(unknown, wctx)
     if not opts.get('ignore') or opts.get('all'):
         showfiles = kwfiles, kwdeleted, kwunknown
     else:
         showfiles = [], [], []
     if opts.get('all') or opts.get('ignore'):
         showfiles += ([f for f in files if f not in kwfiles],
                       [f for f in unknown if f not in kwunknown])
     kwlabels = 'enabled deleted enabledunknown ignored ignoredunknown'.split()
     kwstates = zip(kwlabels, 'K!kIi', showfiles)
     fm = ui.formatter('kwfiles', opts)
     fmt = '%.0s%s\n'
     if opts.get('all') or ui.verbose:
         fmt = '%s %s\n'
     for kwstate, char, filenames in kwstates:
         label = 'kwfiles.' + kwstate
         for f in filenames:
             fm.startitem()
             fm.write('kwstatus path', fmt, char,
                      repo.pathto(f, cwd), label=label)
     fm.end()
 
 @command('kwshrink', commands.walkopts, _('hg kwshrink [OPTION]... [FILE]...'))
 def shrink(ui, repo, *pats, **opts):
     '''revert expanded keywords in the working directory
 
     Must be run before changing/disabling active keywords.
 
     kwshrink refuses to run if given files contain local changes.
     '''
     # 3rd argument sets expansion to False
     _kwfwrite(ui, repo, False, *pats, **opts)
 
 
 def uisetup(ui):
     ''' Monkeypatches dispatch._parse to retrieve user command.'''
 
     def kwdispatch_parse(orig, ui, args):
         '''Monkeypatch dispatch._parse to obtain running hg command.'''
         cmd, func, args, options, cmdoptions = orig(ui, args)
         kwtools['hgcmd'] = cmd
         return cmd, func, args, options, cmdoptions
 
     extensions.wrapfunction(dispatch, '_parse', kwdispatch_parse)
 
 def reposetup(ui, repo):
     '''Sets up repo as kwrepo for keyword substitution.
     Overrides file method to return kwfilelog instead of filelog
     if file matches user configuration.
     Wraps commit to overwrite configured files with updated
     keyword substitutions.
     Monkeypatches patch and webcommands.'''
 
     try:
         if (not repo.local() or kwtools['hgcmd'] in nokwcommands.split()
             or '.hg' in util.splitpath(repo.root)
             or repo._url.startswith('bundle:')):
             return
     except AttributeError:
         pass
 
     inc, exc = [], ['.hg*']
     for pat, opt in ui.configitems('keyword'):
         if opt != 'ignore':
             inc.append(pat)
         else:
             exc.append(pat)
     if not inc:
         return
 
     kwtools['templater'] = kwt = kwtemplater(ui, repo, inc, exc)
 
     class kwrepo(repo.__class__):
         def file(self, f):
             if f[0] == '/':
                 f = f[1:]
             return kwfilelog(self.sopener, kwt, f)
 
         def wread(self, filename):
             data = super(kwrepo, self).wread(filename)
             return kwt.wread(filename, data)
 
         def commit(self, *args, **opts):
             # use custom commitctx for user commands
             # other extensions can still wrap repo.commitctx directly
             self.commitctx = self.kwcommitctx
             try:
                 return super(kwrepo, self).commit(*args, **opts)
             finally:
                 del self.commitctx
 
         def kwcommitctx(self, ctx, error=False):
             n = super(kwrepo, self).commitctx(ctx, error)
             # no lock needed, only called from repo.commit() which already locks
             if not kwt.postcommit:
                 restrict = kwt.restrict
                 kwt.restrict = True
                 kwt.overwrite(self[n], sorted(ctx.added() + ctx.modified()),
                               False, True)
                 kwt.restrict = restrict
             return n
 
         def rollback(self, dryrun=False, force=False):
             wlock = self.wlock()
             try:
                 if not dryrun:
                     changed = self['.'].files()
                 ret = super(kwrepo, self).rollback(dryrun, force)
                 if not dryrun:
                     ctx = self['.']
                     modified, added = _preselect(self[None].status(), changed)
                     kwt.overwrite(ctx, modified, True, True)
                     kwt.overwrite(ctx, added, True, False)
                 return ret
             finally:
                 wlock.release()
 
     # monkeypatches
     def kwpatchfile_init(orig, self, ui, gp, backend, store, eolmode=None):
         '''Monkeypatch/wrap patch.patchfile.__init__ to avoid
         rejects or conflicts due to expanded keywords in working dir.'''
         orig(self, ui, gp, backend, store, eolmode)
         # shrink keywords read from working dir
         self.lines = kwt.shrinklines(self.fname, self.lines)
 
     def kw_diff(orig, repo, node1=None, node2=None, match=None, changes=None,
                 opts=None, prefix=''):
         '''Monkeypatch patch.diff to avoid expansion.'''
         kwt.restrict = True
         return orig(repo, node1, node2, match, changes, opts, prefix)
 
     def kwweb_skip(orig, web, req, tmpl):
         '''Wraps webcommands.x turning off keyword expansion.'''
         kwt.match = util.never
         return orig(web, req, tmpl)
 
     def kw_amend(orig, ui, repo, commitfunc, old, extra, pats, opts):
         '''Wraps cmdutil.amend expanding keywords after amend.'''
         wlock = repo.wlock()
         try:
             kwt.postcommit = True
             newid = orig(ui, repo, commitfunc, old, extra, pats, opts)
             if newid != old.node():
                 ctx = repo[newid]
                 kwt.restrict = True
                 kwt.overwrite(ctx, ctx.files(), False, True)
                 kwt.restrict = False
             return newid
         finally:
             wlock.release()
 
     def kw_copy(orig, ui, repo, pats, opts, rename=False):
         '''Wraps cmdutil.copy so that copy/rename destinations do not
         contain expanded keywords.
         Note that the source of a regular file destination may also be a
         symlink:
         hg cp sym x                -> x is symlink
         cp sym x; hg cp -A sym x   -> x is file (maybe expanded keywords)
         For the latter we have to follow the symlink to find out whether its
         target is configured for expansion and we therefore must unexpand the
         keywords in the destination.'''
         wlock = repo.wlock()
         try:
             orig(ui, repo, pats, opts, rename)
             if opts.get('dry_run'):
                 return
             wctx = repo[None]
             cwd = repo.getcwd()
 
             def haskwsource(dest):
                 '''Returns true if dest is a regular file and configured for
                 expansion or a symlink which points to a file configured for
                 expansion. '''
                 source = repo.dirstate.copied(dest)
                 if 'l' in wctx.flags(source):
                     source = pathutil.canonpath(repo.root, cwd,
                                                os.path.realpath(source))
                 return kwt.match(source)
 
             candidates = [f for f in repo.dirstate.copies() if
                           'l' not in wctx.flags(f) and haskwsource(f)]
             kwt.overwrite(wctx, candidates, False, False)
         finally:
             wlock.release()
 
     def kw_dorecord(orig, ui, repo, commitfunc, *pats, **opts):
         '''Wraps record.dorecord expanding keywords after recording.'''
         wlock = repo.wlock()
         try:
             # record returns 0 even when nothing has changed
             # therefore compare nodes before and after
             kwt.postcommit = True
             ctx = repo['.']
             wstatus = repo[None].status()
             ret = orig(ui, repo, commitfunc, *pats, **opts)
             recctx = repo['.']
             if ctx != recctx:
                 modified, added = _preselect(wstatus, recctx.files())
                 kwt.restrict = False
                 kwt.overwrite(recctx, modified, False, True)
                 kwt.overwrite(recctx, added, False, True, True)
                 kwt.restrict = True
             return ret
         finally:
             wlock.release()
 
     def kwfilectx_cmp(orig, self, fctx):
         # keyword affects data size, comparing wdir and filelog size does
         # not make sense
         if (fctx._filerev is None and
             (self._repo._encodefilterpats or
              kwt.match(fctx.path()) and 'l' not in fctx.flags() or
              self.size() - 4 == fctx.size()) or
             self.size() == fctx.size()):
             return self._filelog.cmp(self._filenode, fctx.data())
         return True
 
     extensions.wrapfunction(context.filectx, 'cmp', kwfilectx_cmp)
     extensions.wrapfunction(patch.patchfile, '__init__', kwpatchfile_init)
     extensions.wrapfunction(patch, 'diff', kw_diff)
     extensions.wrapfunction(cmdutil, 'amend', kw_amend)
     extensions.wrapfunction(cmdutil, 'copy', kw_copy)
     for c in 'annotate changeset rev filediff diff'.split():
         extensions.wrapfunction(webcommands, c, kwweb_skip)
     for name in recordextensions.split():
         try:
             record = extensions.find(name)
             extensions.wrapfunction(record, 'dorecord', kw_dorecord)
         except KeyError:
             pass
 
     repo.__class__ = kwrepo

tests/test-keyword.t

@@ -1,1261 +1,1274 b''
   $ cat <<EOF >> $HGRCPATH
   > [extensions]
   > keyword =
   > mq =
   > notify =
   > record =
   > transplant =
   > [ui]
   > interactive = true
   > EOF
 
 hide outer repo
   $ hg init
 
 Run kwdemo before [keyword] files are set up
 as it would succeed without uisetup otherwise
 
   $ hg --quiet kwdemo
   [extensions]
   keyword =
   [keyword]
   demo.txt = 
   [keywordset]
   svn = False
   [keywordmaps]
   Author = {author|user}
   Date = {date|utcdate}
   Header = {root}/{file},v {node|short} {date|utcdate} {author|user}
   Id = {file|basename},v {node|short} {date|utcdate} {author|user}
   RCSFile = {file|basename},v
   RCSfile = {file|basename},v
   Revision = {node|short}
   Source = {root}/{file},v
   $Author: test $
   $Date: ????/??/?? ??:??:?? $ (glob)
   $Header: */demo.txt,v ???????????? ????/??/?? ??:??:?? test $ (glob)
   $Id: demo.txt,v ???????????? ????/??/?? ??:??:?? test $ (glob)
   $RCSFile: demo.txt,v $
   $RCSfile: demo.txt,v $
   $Revision: ???????????? $ (glob)
   $Source: */demo.txt,v $ (glob)
 
   $ hg --quiet kwdemo "Branch = {branches}"
   [extensions]
   keyword =
   [keyword]
   demo.txt = 
   [keywordset]
   svn = False
   [keywordmaps]
   Branch = {branches}
   $Branch: demobranch $
 
   $ cat <<EOF >> $HGRCPATH
   > [keyword]
   > ** =
   > b = ignore
   > i = ignore
   > [hooks]
   > EOF
   $ cp $HGRCPATH $HGRCPATH.nohooks
   > cat <<EOF >> $HGRCPATH
   > commit=
   > commit.test=cp a hooktest
   > EOF
 
   $ hg init Test-bndl
   $ cd Test-bndl
 
 kwshrink should exit silently in empty/invalid repo
 
   $ hg kwshrink
 
 Symlinks cannot be created on Windows.
 A bundle to test this was made with:
  hg init t
  cd t
  echo a > a
  ln -s a sym
  hg add sym
  hg ci -m addsym -u mercurial
  hg bundle --base null ../test-keyword.hg
 
   $ hg pull -u "$TESTDIR"/bundles/test-keyword.hg
   pulling from *test-keyword.hg (glob)
   requesting all changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
   $ echo 'expand $Id$' > a
   $ echo 'do not process $Id:' >> a
   $ echo 'xxx $' >> a
   $ echo 'ignore $Id$' > b
 
 Output files as they were created
 
   $ cat a b
   expand $Id$
   do not process $Id:
   xxx $
   ignore $Id$
 
 no kwfiles
 
   $ hg kwfiles
 
 untracked candidates
 
   $ hg -v kwfiles --unknown
   k a
 
 Add files and check status
 
   $ hg addremove
   adding a
   adding b
   $ hg status
   A a
   A b
 
 
 Default keyword expansion including commit hook
 Interrupted commit should not change state or run commit hook
 
   $ hg --debug commit
   abort: empty commit message
   [255]
   $ hg status
   A a
   A b
 
 Commit with several checks
 
   $ hg --debug commit -mabsym -u 'User Name <[e-mail]>'
   a
   b
   overwriting a expanding keywords
   running hook commit.test: cp a hooktest
   committed changeset 1:ef63ca68695bc9495032c6fda1350c71e6d256e9
   $ hg status
   ? hooktest
   $ hg debugrebuildstate
   $ hg --quiet identify
   ef63ca68695b
 
 cat files in working directory with keywords expanded
 
   $ cat a b
   expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
   do not process $Id:
   xxx $
   ignore $Id$
 
 hg cat files and symlink, no expansion
 
   $ hg cat sym a b && echo
   expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
   do not process $Id:
   xxx $
   ignore $Id$
   a
 
   $ diff a hooktest
 
   $ cp $HGRCPATH.nohooks $HGRCPATH
   $ rm hooktest
 
 hg status of kw-ignored binary file starting with '\1\n'
 
   >>> open("i", "wb").write("\1\nfoo")
   $ hg -q commit -Am metasep i
   $ hg status
   >>> open("i", "wb").write("\1\nbar")
   $ hg status
   M i
   $ hg -q commit -m "modify metasep" i
   $ hg status --rev 2:3
   M i
   $ touch empty
   $ hg -q commit -A -m "another file"
   $ hg status -A --rev 3:4 i
   C i
 
   $ hg -q strip -n 2
 
 Test hook execution
 
 bundle
 
   $ hg bundle --base null ../kw.hg
   2 changesets found
   $ cd ..
   $ hg init Test
   $ cd Test
 
 Notify on pull to check whether keywords stay as is in email
 ie. if patch.diff wrapper acts as it should
 
   $ cat <<EOF >> $HGRCPATH
   > [hooks]
   > incoming.notify = python:hgext.notify.hook
   > [notify]
   > sources = pull
   > diffstat = False
   > maxsubject = 15
   > [reposubs]
   > * = Test
   > EOF
 
 Pull from bundle and trigger notify
 
   $ hg pull -u ../kw.hg
   pulling from ../kw.hg
   requesting all changes
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 3 changes to 3 files
   Content-Type: text/plain; charset="us-ascii"
   MIME-Version: 1.0
   Content-Transfer-Encoding: 7bit
   Date: * (glob)
   Subject: changeset in...
   From: mercurial
   X-Hg-Notification: changeset a2392c293916
   Message-Id: <hg.a2392c293916*> (glob)
   To: Test
   
   changeset a2392c293916 in $TESTTMP/Test (glob)
   details: $TESTTMP/Test?cmd=changeset;node=a2392c293916
   description:
   	addsym
   
   diffs (6 lines):
   
   diff -r 000000000000 -r a2392c293916 sym
   --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
   +++ b/sym	Sat Feb 09 20:25:47 2008 +0100
   @@ -0,0 +1,1 @@
   +a
   \ No newline at end of file
   Content-Type: text/plain; charset="us-ascii"
   MIME-Version: 1.0
   Content-Transfer-Encoding: 7bit
   Date:* (glob)
   Subject: changeset in...
   From: User Name <[e-mail]>
   X-Hg-Notification: changeset ef63ca68695b
   Message-Id: <hg.ef63ca68695b*> (glob)
   To: Test
   
   changeset ef63ca68695b in $TESTTMP/Test (glob)
   details: $TESTTMP/Test?cmd=changeset;node=ef63ca68695b
   description:
   	absym
   
   diffs (12 lines):
   
   diff -r a2392c293916 -r ef63ca68695b a
   --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
   +++ b/a	Thu Jan 01 00:00:00 1970 +0000
   @@ -0,0 +1,3 @@
   +expand $Id$
   +do not process $Id:
   +xxx $
   diff -r a2392c293916 -r ef63ca68695b b
   --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
   +++ b/b	Thu Jan 01 00:00:00 1970 +0000
   @@ -0,0 +1,1 @@
   +ignore $Id$
   3 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
   $ cp $HGRCPATH.nohooks $HGRCPATH
 
 Touch files and check with status
 
   $ touch a b
   $ hg status
 
 Update and expand
 
   $ rm sym a b
   $ hg update -C
   3 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ cat a b
   expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
   do not process $Id:
   xxx $
   ignore $Id$
 
 Check whether expansion is filewise and file mode is preserved
 
   $ echo '$Id$' > c
   $ echo 'tests for different changenodes' >> c
 #if unix-permissions
   $ chmod 600 c
   $ ls -l c | cut -b 1-10
   -rw-------
 #endif
 
 commit file c
 
   $ hg commit -A -mcndiff -d '1 0' -u 'User Name <[e-mail]>'
   adding c
 #if unix-permissions
   $ ls -l c | cut -b 1-10
   -rw-------
 #endif
 
 force expansion
 
   $ hg -v kwexpand
   overwriting a expanding keywords
   overwriting c expanding keywords
 
 compare changenodes in a and c
 
   $ cat a c
   expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
   do not process $Id:
   xxx $
   $Id: c,v 40a904bbbe4c 1970/01/01 00:00:01 user $
   tests for different changenodes
 
 record
 
   $ echo '$Id$' > r
   $ hg add r
 
 record chunk
 
   >>> lines = open('a', 'rb').readlines()
   >>> lines.insert(1, 'foo\n')
   >>> lines.append('bar\n')
   >>> open('a', 'wb').writelines(lines)
   $ hg record -d '10 1' -m rectest a<<EOF
   > y
   > y
   > n
   > EOF
   diff --git a/a b/a
   2 hunks, 2 lines changed
   examine changes to 'a'? [Ynesfdaq?] 
   @@ -1,3 +1,4 @@
    expand $Id$
   +foo
    do not process $Id:
    xxx $
   record change 1/2 to 'a'? [Ynesfdaq?] 
   @@ -2,2 +3,3 @@
    do not process $Id:
    xxx $
   +bar
   record change 2/2 to 'a'? [Ynesfdaq?] 
 
   $ hg identify
   5f5eb23505c3+ tip
   $ hg status
   M a
   A r
 
 Cat modified file a
 
   $ cat a
   expand $Id: a,v 5f5eb23505c3 1970/01/01 00:00:10 test $
   foo
   do not process $Id:
   xxx $
   bar
 
 Diff remaining chunk
 
   $ hg diff a
   diff -r 5f5eb23505c3 a
   --- a/a	Thu Jan 01 00:00:09 1970 -0000
   +++ b/a	* (glob)
   @@ -2,3 +2,4 @@
    foo
    do not process $Id:
    xxx $
   +bar
 
   $ hg rollback
   repository tip rolled back to revision 2 (undo commit)
   working directory now based on revision 2
 
 Record all chunks in file a
 
   $ echo foo > msg
 
  - do not use "hg record -m" here!
 
   $ hg record -l msg -d '11 1' a<<EOF
   > y
   > y
   > y
   > EOF
   diff --git a/a b/a
   2 hunks, 2 lines changed
   examine changes to 'a'? [Ynesfdaq?] 
   @@ -1,3 +1,4 @@
    expand $Id$
   +foo
    do not process $Id:
    xxx $
   record change 1/2 to 'a'? [Ynesfdaq?] 
   @@ -2,2 +3,3 @@
    do not process $Id:
    xxx $
   +bar
   record change 2/2 to 'a'? [Ynesfdaq?] 
 
 File a should be clean
 
   $ hg status -A a
   C a
 
 rollback and revert expansion
 
   $ cat a
   expand $Id: a,v 78e0a02d76aa 1970/01/01 00:00:11 test $
   foo
   do not process $Id:
   xxx $
   bar
   $ hg --verbose rollback
   repository tip rolled back to revision 2 (undo commit)
   working directory now based on revision 2
   overwriting a expanding keywords
   $ hg status a
   M a
   $ cat a
   expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
   foo
   do not process $Id:
   xxx $
   bar
   $ echo '$Id$' > y
   $ echo '$Id$' > z
   $ hg add y
   $ hg commit -Am "rollback only" z
   $ cat z
   $Id: z,v 45a5d3adce53 1970/01/01 00:00:00 test $
   $ hg --verbose rollback
   repository tip rolled back to revision 2 (undo commit)
   working directory now based on revision 2
   overwriting z shrinking keywords
 
 Only z should be overwritten
 
   $ hg status a y z
   M a
   A y
   A z
   $ cat z
   $Id$
   $ hg forget y z
   $ rm y z
 
 record added file alone
 
   $ hg -v record -l msg -d '12 2' r<<EOF
   > y
   > EOF
   diff --git a/r b/r
   new file mode 100644
   examine changes to 'r'? [Ynesfdaq?] 
   r
   committed changeset 3:82a2f715724d
   overwriting r expanding keywords
  - status call required for dirstate.normallookup() check
   $ hg status r
   $ hg --verbose rollback
   repository tip rolled back to revision 2 (undo commit)
   working directory now based on revision 2
   overwriting r shrinking keywords
   $ hg forget r
   $ rm msg r
   $ hg update -C
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
 record added keyword ignored file
 
   $ echo '$Id$' > i
   $ hg add i
   $ hg --verbose record -d '13 1' -m recignored<<EOF
   > y
   > EOF
   diff --git a/i b/i
   new file mode 100644
   examine changes to 'i'? [Ynesfdaq?] 
   i
   committed changeset 3:9f40ceb5a072
   $ cat i
   $Id$
   $ hg -q rollback
   $ hg forget i
   $ rm i
 
 amend
 
   $ echo amend >> a
   $ echo amend >> b
   $ hg -q commit -d '14 1' -m 'prepare amend'
 
   $ hg --debug commit --amend -d '15 1' -m 'amend without changes' | grep keywords
   invalid branchheads cache (served): tip differs
   overwriting a expanding keywords
   $ hg -q id
   67d8c481a6be
   $ head -1 a
   expand $Id: a,v 67d8c481a6be 1970/01/01 00:00:15 test $
 
   $ hg -q strip -n tip
 
 Test patch queue repo
 
   $ hg init --mq
   $ hg qimport -r tip -n mqtest.diff
   $ hg commit --mq -m mqtest
 
 Keywords should not be expanded in patch
 
   $ cat .hg/patches/mqtest.diff
   # HG changeset patch
   # User User Name <[e-mail]>
   # Date 1 0
   #      Thu Jan 01 00:00:01 1970 +0000
   # Node ID 40a904bbbe4cd4ab0a1f28411e35db26341a40ad
   # Parent  ef63ca68695bc9495032c6fda1350c71e6d256e9
   cndiff
   
   diff -r ef63ca68695b -r 40a904bbbe4c c
   --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
   +++ b/c	Thu Jan 01 00:00:01 1970 +0000
   @@ -0,0 +1,2 @@
   +$Id$
   +tests for different changenodes
 
   $ hg qpop
   popping mqtest.diff
   patch queue now empty
 
 qgoto, implying qpush, should expand
 
   $ hg qgoto mqtest.diff
   applying mqtest.diff
   now at: mqtest.diff
   $ cat c
   $Id: c,v 40a904bbbe4c 1970/01/01 00:00:01 user $
   tests for different changenodes
   $ hg cat c
   $Id: c,v 40a904bbbe4c 1970/01/01 00:00:01 user $
   tests for different changenodes
 
 Keywords should not be expanded in filelog
 
   $ hg --config 'extensions.keyword=!' cat c
   $Id$
   tests for different changenodes
 
 qpop and move on
 
   $ hg qpop
   popping mqtest.diff
   patch queue now empty
 
 Copy and show added kwfiles
 
   $ hg cp a c
   $ hg kwfiles
   a
   c
 
 Commit and show expansion in original and copy
 
   $ hg --debug commit -ma2c -d '1 0' -u 'User Name <[e-mail]>'
   invalid branchheads cache (served): tip differs
   c
    c: copy a:0045e12f6c5791aac80ca6cbfd97709a88307292
   invalid branchheads cache (served): tip differs
   overwriting c expanding keywords
   committed changeset 2:25736cf2f5cbe41f6be4e6784ef6ecf9f3bbcc7d
   $ cat a c
   expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
   do not process $Id:
   xxx $
   expand $Id: c,v 25736cf2f5cb 1970/01/01 00:00:01 user $
   do not process $Id:
   xxx $
 
 Touch copied c and check its status
 
   $ touch c
   $ hg status
 
 Copy kwfile to keyword ignored file unexpanding keywords
 
   $ hg --verbose copy a i
   copying a to i
   overwriting i shrinking keywords
   $ head -n 1 i
   expand $Id$
   $ hg forget i
   $ rm i
 
 Copy ignored file to ignored file: no overwriting
 
   $ hg --verbose copy b i
   copying b to i
   $ hg forget i
   $ rm i
 
 cp symlink file; hg cp -A symlink file (part1)
 - copied symlink points to kwfile: overwrite
 
 #if symlink
   $ cp sym i
   $ ls -l i
   -rw-r--r--* (glob)
   $ head -1 i
   expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
   $ hg copy --after --verbose sym i
   copying sym to i
   overwriting i shrinking keywords
   $ head -1 i
   expand $Id$
   $ hg forget i
   $ rm i
 #endif
 
 Test different options of hg kwfiles
 
   $ hg kwfiles
   a
   c
   $ hg -v kwfiles --ignore
   I b
   I sym
   $ hg kwfiles --all
   K a
   K c
   I b
   I sym
 
 Diff specific revision
 
   $ hg diff --rev 1
   diff -r ef63ca68695b c
   --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
   +++ b/c	* (glob)
   @@ -0,0 +1,3 @@
   +expand $Id$
   +do not process $Id:
   +xxx $
 
 Status after rollback:
 
   $ hg rollback
   repository tip rolled back to revision 1 (undo commit)
   working directory now based on revision 1
   $ hg status
   A c
   $ hg update --clean
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
 #if symlink
 
 cp symlink file; hg cp -A symlink file (part2)
 - copied symlink points to kw ignored file: do not overwrite
 
   $ cat a > i
   $ ln -s i symignored
   $ hg commit -Am 'fake expansion in ignored and symlink' i symignored
   $ cp symignored x
   $ hg copy --after --verbose symignored x
   copying symignored to x
   $ head -n 1 x
   expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
   $ hg forget x
   $ rm x
 
   $ hg rollback
   repository tip rolled back to revision 1 (undo commit)
   working directory now based on revision 1
   $ hg update --clean
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ rm i symignored
 
 #endif
 
 Custom keywordmaps as argument to kwdemo
 
   $ hg --quiet kwdemo "Xinfo = {author}: {desc}"
   [extensions]
   keyword =
   [keyword]
   ** = 
   b = ignore
   demo.txt = 
   i = ignore
   [keywordset]
   svn = False
   [keywordmaps]
   Xinfo = {author}: {desc}
   $Xinfo: test: hg keyword configuration and expansion example $
 
 Configure custom keywordmaps
 
   $ cat <<EOF >>$HGRCPATH
   > [keywordmaps]
   > Id = {file} {node|short} {date|rfc822date} {author|user}
   > Xinfo = {author}: {desc}
   > EOF
 
 Cat and hg cat files before custom expansion
 
   $ cat a b
   expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
   do not process $Id:
   xxx $
   ignore $Id$
   $ hg cat sym a b && echo
   expand $Id: a ef63ca68695b Thu, 01 Jan 1970 00:00:00 +0000 user $
   do not process $Id:
   xxx $
   ignore $Id$
   a
 
 Write custom keyword and prepare multi-line commit message
 
   $ echo '$Xinfo$' >> a
   $ cat <<EOF >> log
   > firstline
   > secondline
   > EOF
 
 Interrupted commit should not change state
 
   $ hg commit
   abort: empty commit message
   [255]
   $ hg status
   M a
   ? c
   ? log
 
 Commit with multi-line message and custom expansion
 
 |Note:
 |
 | After the last rollback, the "served" branchheads cache became invalid, but
 | all changesets in the repo were public. For filtering this means:
 |   "immutable" == "served" == ø.
 |
 | As the "served" cache is invalid, we fall back to the "immutable" cache. But
 | no update is needed between "immutable" and "served" and the "served" cache
 | is not updated on disk. The on-disk version therefore stays invalid for some
 | time. This explains why the "served" branchheads cache is detected as
 | invalid here.
 
   $ hg --debug commit -l log -d '2 0' -u 'User Name <[e-mail]>'
   invalid branchheads cache (served): tip differs
   a
   invalid branchheads cache (served): tip differs
   overwriting a expanding keywords
   committed changeset 2:bb948857c743469b22bbf51f7ec8112279ca5d83
   $ rm log
 
 Stat, verify and show custom expansion (firstline)
 
   $ hg status
   ? c
   $ hg verify
   checking changesets
   checking manifests
   crosschecking files in changesets and manifests
   checking files
   3 files, 3 changesets, 4 total revisions
   $ cat a b
   expand $Id: a bb948857c743 Thu, 01 Jan 1970 00:00:02 +0000 user $
   do not process $Id:
   xxx $
   $Xinfo: User Name <[e-mail]>: firstline $
   ignore $Id$
   $ hg cat sym a b && echo
   expand $Id: a bb948857c743 Thu, 01 Jan 1970 00:00:02 +0000 user $
   do not process $Id:
   xxx $
   $Xinfo: User Name <[e-mail]>: firstline $
   ignore $Id$
   a
 
 annotate
 
   $ hg annotate a
   1: expand $Id$
   1: do not process $Id:
   1: xxx $
   2: $Xinfo$
 
 remove with status checks
 
   $ hg debugrebuildstate
   $ hg remove a
   $ hg --debug commit -m rma
   committed changeset 3:d14c712653769de926994cf7fbb06c8fbd68f012
   $ hg status
   ? c
 
 Rollback, revert, and check expansion
 
   $ hg rollback
   repository tip rolled back to revision 2 (undo commit)
   working directory now based on revision 2
   $ hg status
   R a
   ? c
   $ hg revert --no-backup --rev tip a
   $ cat a
   expand $Id: a bb948857c743 Thu, 01 Jan 1970 00:00:02 +0000 user $
   do not process $Id:
   xxx $
   $Xinfo: User Name <[e-mail]>: firstline $
 
 Clone to test global and local configurations
 
   $ cd ..
 
 Expansion in destination with global configuration
 
   $ hg --quiet clone Test globalconf
   $ cat globalconf/a
   expand $Id: a bb948857c743 Thu, 01 Jan 1970 00:00:02 +0000 user $
   do not process $Id:
   xxx $
   $Xinfo: User Name <[e-mail]>: firstline $
 
 No expansion in destination with local configuration in origin only
 
   $ hg --quiet --config 'keyword.**=ignore' clone Test localconf
   $ cat localconf/a
   expand $Id$
   do not process $Id:
   xxx $
   $Xinfo$
 
 Clone to test incoming
 
   $ hg clone -r1 Test Test-a
   adding changesets
   adding manifests
   adding file changes
   added 2 changesets with 3 changes to 3 files
   updating to branch default
   3 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ cd Test-a
   $ cat <<EOF >> .hg/hgrc
   > [paths]
   > default = ../Test
   > EOF
   $ hg incoming
   comparing with $TESTTMP/Test (glob)
   searching for changes
   changeset:   2:bb948857c743
   tag:         tip
   user:        User Name <[e-mail]>
   date:        Thu Jan 01 00:00:02 1970 +0000
   summary:     firstline
   
 Imported patch should not be rejected
 
   >>> import re
   >>> text = re.sub(r'(Id.*)', r'\1 rejecttest', open('a').read())
   >>> open('a', 'wb').write(text)
   $ hg --debug commit -m'rejects?' -d '3 0' -u 'User Name <[e-mail]>'
   a
   overwriting a expanding keywords
   committed changeset 2:85e279d709ffc28c9fdd1b868570985fc3d87082
   $ hg export -o ../rejecttest.diff tip
   $ cd ../Test
   $ hg import ../rejecttest.diff
   applying ../rejecttest.diff
   $ cat a b
   expand $Id: a 4e0994474d25 Thu, 01 Jan 1970 00:00:03 +0000 user $ rejecttest
   do not process $Id: rejecttest
   xxx $
   $Xinfo: User Name <[e-mail]>: rejects? $
   ignore $Id$
 
   $ hg rollback
   repository tip rolled back to revision 2 (undo import)
   working directory now based on revision 2
   $ hg update --clean
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 
 kwexpand/kwshrink on selected files
 
   $ mkdir x
   $ hg copy a x/a
   $ hg --verbose kwshrink a
   overwriting a shrinking keywords
  - sleep required for dirstate.normal() check
   $ sleep 1
   $ hg status a
   $ hg --verbose kwexpand a
   overwriting a expanding keywords
   $ hg status a
 
 kwexpand x/a should abort
 
   $ hg --verbose kwexpand x/a
   abort: outstanding uncommitted changes
   [255]
   $ cd x
   $ hg --debug commit -m xa -d '3 0' -u 'User Name <[e-mail]>'
   x/a
    x/a: copy a:779c764182ce5d43e2b1eb66ce06d7b47bfe342e
   overwriting x/a expanding keywords
   committed changeset 3:b4560182a3f9a358179fd2d835c15e9da379c1e4
   $ cat a
   expand $Id: x/a b4560182a3f9 Thu, 01 Jan 1970 00:00:03 +0000 user $
   do not process $Id:
   xxx $
   $Xinfo: User Name <[e-mail]>: xa $
 
 kwshrink a inside directory x
 
   $ hg --verbose kwshrink a
   overwriting x/a shrinking keywords
   $ cat a
   expand $Id$
   do not process $Id:
   xxx $
   $Xinfo$
   $ cd ..
 
 kwexpand nonexistent
 
   $ hg kwexpand nonexistent
   nonexistent:* (glob)
 
 
 #if serve
 hg serve
  - expand with hgweb file
  - no expansion with hgweb annotate/changeset/filediff
  - check errors
 
   $ hg serve -p $HGPORT -d --pid-file=hg.pid -A access.log -E errors.log
   $ cat hg.pid >> $DAEMON_PIDS
   $ "$TESTDIR/get-with-headers.py" localhost:$HGPORT 'file/tip/a/?style=raw'
   200 Script output follows
   
   expand $Id: a bb948857c743 Thu, 01 Jan 1970 00:00:02 +0000 user $
   do not process $Id:
   xxx $
   $Xinfo: User Name <[e-mail]>: firstline $
   $ "$TESTDIR/get-with-headers.py" localhost:$HGPORT 'annotate/tip/a/?style=raw'
   200 Script output follows
   
   
   user@1: expand $Id$
   user@1: do not process $Id:
   user@1: xxx $
   user@2: $Xinfo$
   
   
   
   
   $ "$TESTDIR/get-with-headers.py" localhost:$HGPORT 'rev/tip/?style=raw'
   200 Script output follows
   
   
   # HG changeset patch
   # User User Name <[e-mail]>
   # Date 3 0
   # Node ID b4560182a3f9a358179fd2d835c15e9da379c1e4
   # Parent  bb948857c743469b22bbf51f7ec8112279ca5d83
   xa
   
   diff -r bb948857c743 -r b4560182a3f9 x/a
   --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
   +++ b/x/a	Thu Jan 01 00:00:03 1970 +0000
   @@ -0,0 +1,4 @@
   +expand $Id$
   +do not process $Id:
   +xxx $
   +$Xinfo$
   
   $ "$TESTDIR/get-with-headers.py" localhost:$HGPORT 'diff/bb948857c743/a?style=raw'
   200 Script output follows
   
   
   diff -r ef63ca68695b -r bb948857c743 a
   --- a/a	Thu Jan 01 00:00:00 1970 +0000
   +++ b/a	Thu Jan 01 00:00:02 1970 +0000
   @@ -1,3 +1,4 @@
    expand $Id$
    do not process $Id:
    xxx $
   +$Xinfo$
   
   
   
   
   $ cat errors.log
 #endif
 
 Prepare merge and resolve tests
 
   $ echo '$Id$' > m
   $ hg add m
   $ hg commit -m 4kw
   $ echo foo >> m
   $ hg commit -m 5foo
 
 simplemerge
 
   $ hg update 4
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo foo >> m
   $ hg commit -m 6foo
   created new head
   $ hg merge
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   (branch merge, don't forget to commit)
   $ hg commit -m simplemerge
   $ cat m
   $Id: m 27d48ee14f67 Thu, 01 Jan 1970 00:00:00 +0000 test $
   foo
 
 conflict: keyword should stay outside conflict zone
 
   $ hg update 4
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ echo bar >> m
   $ hg commit -m 8bar
   created new head
   $ hg merge
   merging m
   warning: conflicts during merge.
   merging m incomplete! (edit conflicts, then use 'hg resolve --mark')
   0 files updated, 0 files merged, 0 files removed, 1 files unresolved
   use 'hg resolve' to retry unresolved file merges or 'hg update -C .' to abandon
   [1]
   $ cat m
   $Id$
   <<<<<<< local
   bar
   =======
   foo
   >>>>>>> other
 
 resolve to local
 
   $ HGMERGE=internal:local hg resolve -a
   $ hg commit -m localresolve
   $ cat m
   $Id: m 800511b3a22d Thu, 01 Jan 1970 00:00:00 +0000 test $
   bar
 
 Test restricted mode with transplant -b
 
   $ hg update 6
   1 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg branch foo
   marked working directory as branch foo
   (branches are permanent and global, did you want a bookmark?)
   $ mv a a.bak
   $ echo foobranch > a
   $ cat a.bak >> a
   $ rm a.bak
   $ hg commit -m 9foobranch
   $ hg update default
   2 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ hg -y transplant -b foo tip
   applying 4aa30d025d50
   4aa30d025d50 transplanted to e00abbf63521
 
 Expansion in changeset but not in file
 
   $ hg tip -p
   changeset:   11:e00abbf63521
   tag:         tip
   parent:      9:800511b3a22d
   user:        test
   date:        Thu Jan 01 00:00:00 1970 +0000
   summary:     9foobranch
   
   diff -r 800511b3a22d -r e00abbf63521 a
   --- a/a	Thu Jan 01 00:00:00 1970 +0000
   +++ b/a	Thu Jan 01 00:00:00 1970 +0000
   @@ -1,3 +1,4 @@
   +foobranch
    expand $Id$
    do not process $Id:
    xxx $
   
   $ head -n 2 a
   foobranch
   expand $Id: a e00abbf63521 Thu, 01 Jan 1970 00:00:00 +0000 test $
 
 Turn off expansion
 
   $ hg -q rollback
   $ hg -q update -C
 
 kwshrink with unknown file u
 
   $ cp a u
   $ hg --verbose kwshrink
   overwriting a shrinking keywords
   overwriting m shrinking keywords
   overwriting x/a shrinking keywords
 
 Keywords shrunk in working directory, but not yet disabled
  - cat shows unexpanded keywords
  - hg cat shows expanded keywords
 
   $ cat a b
   expand $Id$
   do not process $Id:
   xxx $
   $Xinfo$
   ignore $Id$
   $ hg cat sym a b && echo
   expand $Id: a bb948857c743 Thu, 01 Jan 1970 00:00:02 +0000 user $
   do not process $Id:
   xxx $
   $Xinfo: User Name <[e-mail]>: firstline $
   ignore $Id$
   a
 
 Now disable keyword expansion
 
   $ cp $HGRCPATH $HGRCPATH.backup
   $ rm "$HGRCPATH"
   $ cat a b
   expand $Id$
   do not process $Id:
   xxx $
   $Xinfo$
   ignore $Id$
   $ hg cat sym a b && echo
   expand $Id$
   do not process $Id:
   xxx $
   $Xinfo$
   ignore $Id$
   a
 
 enable keyword expansion again
 
   $ cat $HGRCPATH.backup >> $HGRCPATH
 
 Test restricted mode with unshelve
 
   $ cat <<EOF >> $HGRCPATH
   > [extensions]
   > shelve =
   > EOF
 
   $ echo xxxx >> a
   $ hg diff
   diff -r 800511b3a22d a
   --- a/a	Thu Jan 01 00:00:00 1970 +0000
   +++ b/a	* (glob)
   @@ -2,3 +2,4 @@
    do not process $Id:
    xxx $
    $Xinfo$
   +xxxx
   $ hg shelve -q --name tmp
   $ hg shelve --list --patch
   tmp             (*)    changes to 'localresolve' (glob)
   
   diff --git a/a b/a
   --- a/a
   +++ b/a
   @@ -2,3 +2,4 @@
    do not process $Id:
    xxx $
    $Xinfo$
   +xxxx
 
   $ hg update -q -C 10
   $ hg unshelve -q tmp
   $ hg diff
   diff -r 4aa30d025d50 a
   --- a/a	Thu Jan 01 00:00:00 1970 +0000
   +++ b/a	* (glob)
   @@ -3,3 +3,4 @@
    do not process $Id:
    xxx $
    $Xinfo$
   +xxxx
 
 Test restricted mode with rebase
 
   $ cat <<EOF >> $HGRCPATH
   > [extensions]
   > rebase =
   > EOF
 
   $ hg update -q -C 9
 
   $ echo xxxx >> a
   $ hg commit -m '#11'
   $ hg diff -c 11
   diff -r 800511b3a22d -r b07670694489 a
   --- a/a	Thu Jan 01 00:00:00 1970 +0000
   +++ b/a	Thu Jan 01 00:00:00 1970 +0000
   @@ -2,3 +2,4 @@
    do not process $Id:
    xxx $
    $Xinfo$
   +xxxx
 
   $ hg diff -c 10
   diff -r 27d48ee14f67 -r 4aa30d025d50 a
   --- a/a	Thu Jan 01 00:00:00 1970 +0000
   +++ b/a	Thu Jan 01 00:00:00 1970 +0000
   @@ -1,3 +1,4 @@
   +foobranch
    expand $Id$
    do not process $Id:
    xxx $
 
   $ hg rebase -q -s 10 -d 11 --keep
   $ hg diff -r 9 -r 12 a
   diff -r 800511b3a22d -r 1939b927726c a
   --- a/a	Thu Jan 01 00:00:00 1970 +0000
   +++ b/a	Thu Jan 01 00:00:00 1970 +0000
   @@ -1,4 +1,6 @@
   +foobranch
    expand $Id$
    do not process $Id:
    xxx $
    $Xinfo$
   +xxxx
 
 Test restricted mode with graft
 
   $ hg graft -q 10
   $ hg diff -r 9 -r 13 a
   diff -r 800511b3a22d -r 01a68de1003a a
   --- a/a	Thu Jan 01 00:00:00 1970 +0000
   +++ b/a	Thu Jan 01 00:00:00 1970 +0000
   @@ -1,4 +1,6 @@
   +foobranch
    expand $Id$
    do not process $Id:
    xxx $
    $Xinfo$
   +xxxx
 
+Test restricted mode with backout
+
+  $ hg backout -q 11
+  $ hg diff a
+  diff -r 01a68de1003a a
+  --- a/a	Thu Jan 01 00:00:00 1970 +0000
+  +++ b/a	* (glob)
+  @@ -3,4 +3,3 @@
+   do not process $Id:
+   xxx $
+   $Xinfo$
+  -xxxx
+
   $ cd ..