keyword: safeguards against erroneous behaviour or aborts

prevent issues due to global [keyword] filename patterns:
- add email to nokwcommands
- protect everything under .hg from expansion
  (tested with qcommit)
- exclude everything starting with .hg* just in case

prevent abort when pulling from bundlerepo:
- do not set up kwrepo for bundlerepo
  expansion inside a bundle is nonsense

bundlerepo issue spotted and test case provided by pmezard.

hgext/keyword.py

@@ -1,520 +1,524 b''
 # keyword.py - $Keyword$ expansion for Mercurial
 #
 # Copyright 2007, 2008 Christian Ebert <[e-mail]>
 #
 # This software may be used and distributed according to the terms
 # of the GNU General Public License, incorporated herein by reference.
 #
 # $Id$
 #
 # Keyword expansion hack against the grain of a DSCM
 #
 # 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://www.selenic.com/mercurial/wiki/index.cgi/KeywordPlan>.
 #
 # Keyword expansion is based on Mercurial's changeset template mappings.
 #
 # Binary files are not touched.
 #
 # Setup in hgrc:
 #
 #   [extensions]
 #   # enable extension
 #   hgext.keyword =
 #
 # 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.
 
 '''keyword expansion in local repositories
 
 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.
 
 Configuration is done in the [keyword] and [keywordmaps] sections
 of hgrc files.
 
 Example:
 
     [keyword]
     # expand keywords in every python file except those matching "x*"
     **.py =
     x*    = ignore
 
 Note: the more specific you are in your filename patterns
       the less you lose speed in huge repos.
 
 For [keywordmaps] template mapping and expansion demonstration and
 control run "hg kwdemo".
 
 An additional date template filter {date|utcdate} is provided.
 
 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 config changes.
 
 Before changing/disabling active keywords, run "hg kwshrink" to avoid
 the risk of inadvertedly storing expanded keywords in the change history.
 
 To force expansion after enabling it, or a configuration change, run
 "hg kwexpand".
 
 Also, when committing with the record extension or using mq's qrecord, be aware
 that keywords cannot be updated. Again, run "hg kwexpand" on the files in
 question to update keyword expansions after all changes have been checked in.
 
 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, cmdutil, context, dispatch, filelog, revlog
 from mercurial import patch, localrepo, templater, templatefilters, util
 from mercurial.node import *
 from mercurial.i18n import _
 import re, shutil, sys, tempfile, time
 
 commands.optionalrepo += ' kwdemo'
 
 # hg commands that do not act on keywords
 nokwcommands = ('add addremove bundle copy export grep identify incoming init'
-                ' log outgoing push remove rename rollback tip convert')
+                ' log outgoing push remove rename rollback tip convert email')
 
 # hg commands that trigger expansion only when writing to working dir,
 # not when reading filelog, and unexpand when reading from working dir
 restricted = 'diff1 record qfold qimport qnew qpush qrefresh qrecord'
 
 def utcdate(date):
     '''Returns hgdate in cvs-like UTC format.'''
     return time.strftime('%Y/%m/%d %H:%M:%S', time.gmtime(date[0]))
 
 
 _kwtemplater = None
 
 class kwtemplater(object):
     '''
     Sets up keyword templates, corresponding keyword regex, and
     provides keyword substitution functions.
     '''
     templates = {
         'Revision': '{node|short}',
         'Author': '{author|user}',
         'Date': '{date|utcdate}',
         'RCSFile': '{file|basename},v',
         'Source': '{root}/{file},v',
         'Id': '{file|basename},v {node|short} {date|utcdate} {author|user}',
         'Header': '{root}/{file},v {node|short} {date|utcdate} {author|user}',
     }
 
     def __init__(self, ui, repo, inc, exc, restrict):
         self.ui = ui
         self.repo = repo
         self.matcher = util.matcher(repo.root, inc=inc, exc=exc)[1]
         self.restrict = restrict
         self.commitnode = None
         self.path = ''
 
         kwmaps = self.ui.configitems('keywordmaps')
         if kwmaps: # override default templates
             kwmaps = [(k, templater.parsestring(v, quoted=False))
                       for (k, v) in kwmaps]
             self.templates = dict(kwmaps)
         escaped = map(re.escape, self.templates.keys())
         kwpat = r'\$(%s)(: [^$\n\r]*? )??\$' % '|'.join(escaped)
         self.re_kw = re.compile(kwpat)
 
         templatefilters.filters['utcdate'] = utcdate
         self.ct = cmdutil.changeset_templater(self.ui, self.repo,
                                               False, '', False)
 
     def substitute(self, node, data, subfunc):
         '''Obtains file's changenode if commit node not given,
         and calls given substitution function.'''
         if self.commitnode:
             fnode = self.commitnode
         else:
             c = context.filectx(self.repo, self.path, fileid=node)
             fnode = c.node()
 
         def kwsub(mobj):
             '''Substitutes keyword using corresponding template.'''
             kw = mobj.group(1)
             self.ct.use_template(self.templates[kw])
             self.ui.pushbuffer()
             self.ct.show(changenode=fnode, root=self.repo.root, file=self.path)
             ekw = templatefilters.firstline(self.ui.popbuffer())
             return '$%s: %s $' % (kw, ekw)
 
         return subfunc(kwsub, data)
 
     def expand(self, node, data):
         '''Returns data with keywords expanded.'''
         if self.restrict or util.binary(data):
             return data
         return self.substitute(node, data, self.re_kw.sub)
 
     def process(self, node, data, expand):
         '''Returns a tuple: data, count.
         Count is number of keywords/keyword substitutions,
         telling caller whether to act on file containing data.'''
         if util.binary(data):
             return data, None
         if expand:
             return self.substitute(node, data, self.re_kw.subn)
         return data, self.re_kw.search(data)
 
     def shrink(self, text):
         '''Returns text with all keyword substitutions removed.'''
         if util.binary(text):
             return text
         return self.re_kw.sub(r'$\1$', text)
 
 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, path):
         super(kwfilelog, self).__init__(opener, path)
         _kwtemplater.path = path
 
     def kwctread(self, node, expand):
         '''Reads expanding and counting keywords, called from _overwrite.'''
         data = super(kwfilelog, self).read(node)
         return _kwtemplater.process(node, data, expand)
 
     def read(self, node):
         '''Expands keywords when reading filelog.'''
         data = super(kwfilelog, self).read(node)
         return _kwtemplater.expand(node, data)
 
     def add(self, text, meta, tr, link, p1=None, p2=None):
         '''Removes keyword substitutions when adding to filelog.'''
         text = _kwtemplater.shrink(text)
         return super(kwfilelog, self).add(text, meta, tr, link, p1=p1, p2=p2)
 
     def cmp(self, node, text):
         '''Removes keyword substitutions for comparison.'''
         text = _kwtemplater.shrink(text)
         if self.renamed(node):
             t2 = super(kwfilelog, self).read(node)
             return t2 != text
         return revlog.revlog.cmp(self, node, text)
 
 
 # store original patch.patchfile.__init__
 _patchfile_init = patch.patchfile.__init__
 
 def _kwpatchfile_init(self, ui, fname, missing=False):
     '''Monkeypatch/wrap patch.patchfile.__init__ to avoid
     rejects or conflicts due to expanded keywords in working dir.'''
     _patchfile_init(self, ui, fname, missing=missing)
 
     if _kwtemplater.matcher(self.fname):
         # shrink keywords read from working dir
         kwshrunk = _kwtemplater.shrink(''.join(self.lines))
         self.lines = kwshrunk.splitlines(True)
 
 
 def _iskwfile(f, link):
     return not link(f) and _kwtemplater.matcher(f)
 
 def _status(ui, repo, *pats, **opts):
     '''Bails out if [keyword] configuration is not active.
     Returns status of working directory.'''
     if _kwtemplater:
         files, match, anypats = cmdutil.matchpats(repo, pats, opts)
         return repo.status(files=files, match=match, list_clean=True)
     if ui.configitems('keyword'):
         raise util.Abort(_('[keyword] patterns cannot match'))
     raise util.Abort(_('no [keyword] patterns configured'))
 
 def _overwrite(ui, repo, node=None, expand=True, files=None):
     '''Overwrites selected files expanding/shrinking keywords.'''
     ctx = repo.changectx(node)
     mf = ctx.manifest()
     if node is not None:   # commit
         _kwtemplater.commitnode = node
         files = [f for f in ctx.files() if f in mf]
         notify = ui.debug
     else:                  # kwexpand/kwshrink
         notify = ui.note
     candidates = [f for f in files if _iskwfile(f, mf.linkf)]
     if candidates:
         candidates.sort()
         action = expand and 'expanding' or 'shrinking'
         for f in candidates:
             fp = repo.file(f, kwmatch=True)
             data, kwfound = fp.kwctread(mf[f], expand)
             if kwfound:
                 notify(_('overwriting %s %s keywords\n') % (f, action))
                 repo.wwrite(f, data, mf.flags(f))
                 repo.dirstate.normal(f)
 
 def _kwfwrite(ui, repo, expand, *pats, **opts):
     '''Selects files and passes them to _overwrite.'''
     status = _status(ui, repo, *pats, **opts)
     modified, added, removed, deleted, unknown, ignored, clean = status
     if modified or added or removed or deleted:
         raise util.Abort(_('outstanding uncommitted changes in given files'))
     wlock = lock = None
     try:
         wlock = repo.wlock()
         lock = repo.lock()
         _overwrite(ui, repo, expand=expand, files=clean)
     finally:
         del wlock, lock
 
 
 def demo(ui, repo, *args, **opts):
     '''print [keywordmaps] configuration and an expansion example
 
     Show current, custom, or default keyword template maps
     and their expansion.
 
     Extend current configuration by specifying maps as arguments
     and optionally by reading from an additional hgrc file.
 
     Override current keyword template maps with "default" option.
     '''
     def demostatus(stat):
         ui.status(_('\n\t%s\n') % stat)
 
     def demoitems(section, items):
         ui.write('[%s]\n' % section)
         for k, v in items:
             ui.write('%s = %s\n' % (k, v))
 
     msg = 'hg keyword config and expansion example'
     kwstatus = 'current'
     fn = 'demo.txt'
     branchname = 'demobranch'
     tmpdir = tempfile.mkdtemp('', 'kwdemo.')
     ui.note(_('creating temporary repo at %s\n') % tmpdir)
     repo = localrepo.localrepository(ui, path=tmpdir, create=True)
     ui.setconfig('keyword', fn, '')
     if args or opts.get('rcfile'):
         kwstatus = 'custom'
     if opts.get('rcfile'):
         ui.readconfig(opts.get('rcfile'))
     if opts.get('default'):
         kwstatus = 'default'
         kwmaps = kwtemplater.templates
         if ui.configitems('keywordmaps'):
             # override maps from optional rcfile
             for k, v in kwmaps.iteritems():
                 ui.setconfig('keywordmaps', k, v)
     elif 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'))
     if not opts.get('default'):
         kwmaps = dict(ui.configitems('keywordmaps')) or kwtemplater.templates
     reposetup(ui, repo)
     for k, v in ui.configitems('extensions'):
         if k.endswith('keyword'):
             extension = '%s = %s' % (k, v)
             break
     demostatus('config using %s keyword template maps' % kwstatus)
     ui.write('[extensions]\n%s\n' % extension)
     demoitems('keyword', ui.configitems('keyword'))
     demoitems('keywordmaps', kwmaps.iteritems())
     keywords = '$' + '$\n$'.join(kwmaps.keys()) + '$\n'
     repo.wopener(fn, 'w').write(keywords)
     repo.add([fn])
     path = repo.wjoin(fn)
     ui.note(_('\n%s keywords written to %s:\n') % (kwstatus, path))
     ui.note(keywords)
     ui.note('\nhg -R "%s" branch "%s"\n' % (tmpdir, branchname))
     # silence branch command if not verbose
     quiet = ui.quiet
     ui.quiet = not ui.verbose
     commands.branch(ui, repo, branchname)
     ui.quiet = quiet
     for name, cmd in ui.configitems('hooks'):
         if name.split('.', 1)[0].find('commit') > -1:
             repo.ui.setconfig('hooks', name, '')
     ui.note(_('unhooked all commit hooks\n'))
     ui.note('hg -R "%s" ci -m "%s"\n' % (tmpdir, msg))
     repo.commit(text=msg)
     format = ui.verbose and ' in %s' % path or ''
     demostatus('%s keywords expanded%s' % (kwstatus, format))
     ui.write(repo.wread(fn))
     ui.debug(_('\nremoving temporary repo %s\n') % tmpdir)
     shutil.rmtree(tmpdir, ignore_errors=True)
 
 def expand(ui, repo, *pats, **opts):
     '''expand keywords in 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)
 
 def files(ui, repo, *pats, **opts):
     '''print files currently configured for keyword expansion
 
     Crosscheck which files in working directory are potential targets for
     keyword expansion.
     That is, files matched by [keyword] config patterns but not symlinks.
     '''
     status = _status(ui, repo, *pats, **opts)
     modified, added, removed, deleted, unknown, ignored, clean = status
     files = modified + added + clean
     if opts.get('untracked'):
         files += unknown
     files.sort()
     kwfiles = [f for f in files if _iskwfile(f, repo._link)]
     cwd = pats and repo.getcwd() or ''
     kwfstats = not opts.get('ignore') and (('K', kwfiles),) or ()
     if opts.get('all') or opts.get('ignore'):
         kwfstats += (('I', [f for f in files if f not in kwfiles]),)
     for char, filenames in kwfstats:
         format = (opts.get('all') or ui.verbose) and '%s %%s\n' % char or '%s\n'
         for f in filenames:
             ui.write(format % repo.pathto(f, cwd))
 
 def shrink(ui, repo, *pats, **opts):
     '''revert expanded keywords in working directory
 
     Run before changing/disabling active keywords
     or if you experience problems with "hg import" or "hg merge".
 
     kwshrink refuses to run if given files contain local changes.
     '''
     # 3rd argument sets expansion to False
     _kwfwrite(ui, repo, False, *pats, **opts)
 
 
 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.
     This is done for local repos only, and only if there are
     files configured at all for keyword substitution.'''
 
-    if not repo.local():
-        return
+    try:
+        if (not repo.local() or '.hg' in repo.root.split('/')
+            or repo._url.startswith('bundle:')):
+            return
+    except AttributeError:
+        pass
 
     hgcmd, func, args, opts, cmdopts = dispatch._parse(ui, sys.argv[1:])
     if hgcmd in nokwcommands.split():
         return
 
     if hgcmd == 'diff':
         # only expand if comparing against working dir
         node1, node2 = cmdutil.revpair(repo, cmdopts.get('rev'))
         if node2 is not None:
             return
         # shrink if rev is not current node
         if node1 is not None and node1 != repo.changectx().node():
             hgcmd = 'diff1'
 
-    inc, exc = [], ['.hgtags']
+    inc, exc = [], ['.hg*']
     for pat, opt in ui.configitems('keyword'):
         if opt != 'ignore':
             inc.append(pat)
         else:
             exc.append(pat)
     if not inc:
         return
 
     global _kwtemplater
     restrict = hgcmd in restricted.split()
     _kwtemplater = kwtemplater(ui, repo, inc, exc, restrict)
 
     class kwrepo(repo.__class__):
         def file(self, f, kwmatch=False):
             if f[0] == '/':
                 f = f[1:]
             if kwmatch or _kwtemplater.matcher(f):
                 return kwfilelog(self.sopener, f)
             return filelog.filelog(self.sopener, f)
 
         def wread(self, filename):
             data = super(kwrepo, self).wread(filename)
             if restrict and _kwtemplater.matcher(filename):
                 return _kwtemplater.shrink(data)
             return data
 
         def commit(self, files=None, text='', user=None, date=None,
                    match=util.always, force=False, force_editor=False,
                    p1=None, p2=None, extra={}, empty_ok=False):
             wlock = lock = None
             _p1 = _p2 = None
             try:
                 wlock = self.wlock()
                 lock = self.lock()
                 # store and postpone commit hooks
                 commithooks = {}
                 for name, cmd in ui.configitems('hooks'):
                     if name.split('.', 1)[0] == 'commit':
                         commithooks[name] = cmd
                         ui.setconfig('hooks', name, None)
                 if commithooks:
                     # store parents for commit hook environment
                     if p1 is None:
                         _p1, _p2 = repo.dirstate.parents()
                     else:
                         _p1, _p2 = p1, p2 or nullid
                     _p1 = hex(_p1)
                     if _p2 == nullid:
                         _p2 = ''
                     else:
                         _p2 = hex(_p2)
 
                 node = super(kwrepo,
                              self).commit(files=files, text=text, user=user,
                                           date=date, match=match, force=force,
                                           force_editor=force_editor,
                                           p1=p1, p2=p2, extra=extra,
                                           empty_ok=empty_ok)
 
                 # restore commit hooks
                 for name, cmd in commithooks.iteritems():
                     ui.setconfig('hooks', name, cmd)
                 if node is not None:
                     _overwrite(ui, self, node=node)
                     repo.hook('commit', node=node, parent1=_p1, parent2=_p2)
                 return node
             finally:
                 del wlock, lock
 
     repo.__class__ = kwrepo
     patch.patchfile.__init__ = _kwpatchfile_init
 
 
 cmdtable = {
     'kwdemo':
         (demo,
          [('d', 'default', None, _('show default keyword template maps')),
           ('f', 'rcfile', [], _('read maps from rcfile'))],
          _('hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP]...')),
     'kwexpand': (expand, commands.walkopts,
                  _('hg kwexpand [OPTION]... [FILE]...')),
     'kwfiles':
         (files,
          [('a', 'all', None, _('show keyword status flags of all files')),
           ('i', 'ignore', None, _('show files excluded from expansion')),
           ('u', 'untracked', None, _('additionally show untracked files')),
          ] + commands.walkopts,
          _('hg kwfiles [OPTION]... [FILE]...')),
     'kwshrink': (shrink, commands.walkopts,
                  _('hg kwshrink [OPTION]... [FILE]...')),
 }

tests/test-keyword

@@ -1,253 +1,267 b''
 #!/bin/sh
 
 cat <<EOF >> $HGRCPATH
 [extensions]
 hgext.keyword =
 hgext.mq =
 [keyword]
 * =
 b = ignore
 [hooks]
 commit=
 commit.test=cp a hooktest
 EOF
 
 echo % help
 hg help keyword
 
 echo % hg kwdemo
 hg --quiet kwdemo --default \
 | sed -e 's![^ ][^ ]*demo.txt,v!/TMP/demo.txt,v!' \
  -e 's/,v [a-z0-9][a-z0-9]* /,v xxxxxxxxxxxx /' \
  -e '/[$]Revision/ s/: [a-z0-9][a-z0-9]* /: xxxxxxxxxxxx /' \
  -e 's! 20[0-9][0-9]/[01][0-9]/[0-3][0-9] [0-2][0-9]:[0-6][0-9]:[0-6][0-9]! 2000/00/00 00:00:00!'
 
 hg --quiet kwdemo "Branch = {branches}"
 
-hg init Test
-cd Test
+hg init Test-bndl
+cd Test-bndl
 
 echo % kwshrink should exit silently in empty/invalid repo
 hg kwshrink
 
 echo 'expand $Id$' > a
 echo 'do not process $Id:' >> a
 echo 'xxx $' >> a
 echo 'ignore $Id$' > b
 ln -s a sym
 echo % cat
 cat sym a b
 
 echo % addremove
 hg addremove
 echo % status
 hg status
 
 echo % default keyword expansion including commit hook
 echo % interrupted commit should not change state or run commit hook
 hg --debug commit
 echo % status
 hg status
 
 echo % commit
 hg --debug commit -mabsym -d '0 0' -u 'User Name <[e-mail]>'
 echo % status
 hg status
 echo % identify
 hg --quiet identify
 echo % cat
 cat sym a b
 echo % hg cat
 hg cat sym a b
 
 echo
 echo % diff a hooktest
 diff a hooktest
 
 echo % removing commit hook from config
 sed -e '/\[hooks\]/,$ d' $HGRCPATH > $HGRCPATH.nohook
 mv $HGRCPATH.nohook $HGRCPATH
 rm hooktest
 
+echo % bundle
+hg bundle --base null ../kw.hg
+
+cd ..
+hg init Test
+cd Test
+
+echo % pull from bundle
+hg pull -u ../kw.hg
+
 echo % touch
 touch a b
 echo % status
 hg status
 
 rm sym a b
 echo % update
 hg update
 echo % cat
 cat sym a b
 
 echo % check whether expansion is filewise
 echo '$Id$' > c
 echo 'tests for different changenodes' >> c
 echo % commit c
 hg commit -A -mcndiff -d '1 0' -u 'User Name <[e-mail]>'
 echo % force expansion
 hg -v kwexpand
 echo % compare changenodes in a c
 cat a c
 
+echo % qinit -c
+hg qinit -c
 echo % qimport
 hg qimport -r tip -n mqtest.diff
+echo % qcommit
+hg qcommit -mqtest
 echo % keywords should not be expanded in patch
 cat .hg/patches/mqtest.diff
 echo % qpop
 hg qpop
 echo % qgoto - should imply qpush
 hg qgoto mqtest.diff
 echo % cat
 cat c
 echo % qpop and move on
 hg qpop
 
 echo % copy
 hg cp a c
 
 echo % kwfiles added
 hg kwfiles
 
 echo % commit
 hg --debug commit -ma2c -d '1 0' -u 'User Name <[e-mail]>'
 echo % cat a c
 cat a c
 echo % touch copied c after 1 second
 sleep 1
 touch c
 echo % status
 hg status
 
 echo % kwfiles
 hg kwfiles
 
 echo % diff --rev
 hg diff --rev 0 | grep -v 'b/c'
 
 echo % rollback
 hg rollback
 echo % status
 hg status
 echo % update -C
 hg update --clean
 
 echo % custom keyword expansion
 echo % try with kwdemo
 hg --quiet kwdemo "Xinfo = {author}: {desc}"
 
 cat <<EOF >>$HGRCPATH
 [keywordmaps]
 Id = {file} {node|short} {date|rfc822date} {author|user}
 Xinfo = {author}: {desc}
 EOF
 
 echo % cat
 cat sym a b
 echo % hg cat
 hg cat sym a b
 
 echo
 echo '$Xinfo$' >> a
 cat <<EOF >> log
 firstline
 secondline
 EOF
 
 echo % interrupted commit should not change state
 hg commit
 echo % status
 hg status
 
 echo % commit
 hg --debug commit -l log -d '2 0' -u 'User Name <[e-mail]>'
 rm log
 echo % status
 hg status
 
 echo % cat
 cat sym a b
 echo % hg cat
 hg cat sym a b
 echo
 
 echo % remove
 hg remove a
 hg --debug commit -m rma
 echo % status
 hg status
 echo % rollback
 hg rollback
 echo % status
 hg status
 echo % revert a
 hg revert --no-backup --rev tip a
 echo % cat a
 cat a
 
 echo % clone to test incoming
 cd ..
 hg clone -r0 Test Test-a
 cd Test-a
 cat <<EOF >> .hg/hgrc
 [paths]
 default = ../Test
 EOF
 echo % incoming
 # remove path to temp dir
 hg incoming | sed -e 's/^\(comparing with \).*\(test-keyword.*\)/\1\2/'
 
 sed -e 's/Id.*/& rejecttest/' a > a.new
 mv a.new a
 echo % commit rejecttest
 hg --debug commit -m'rejects?' -d '3 0' -u 'User Name <[e-mail]>'
 echo % export
 hg export -o ../rejecttest.diff tip
 
 cd ../Test
 echo % import
 hg import ../rejecttest.diff
 echo % cat
 cat sym a b
 echo
 echo % rollback
 hg rollback
 echo % clean update
 hg update --clean
 
 echo % kwexpand/kwshrink on selected files
 mkdir x
 echo % copy a x/a
 hg copy a x/a
 echo % kwexpand a
 hg --verbose kwexpand a
 echo % kwexpand x/a should abort
 hg --verbose kwexpand x/a
 cd x
 hg --debug commit -m xa -d '3 0' -u 'User Name <[e-mail]>'
 echo % cat a
 cat a
 echo % kwshrink a inside directory x
 hg --verbose kwshrink a
 echo % cat a
 cat a
 cd ..
 
 echo % kwexpand nonexistent
 hg kwexpand nonexistent
 
 echo % switch off expansion
 echo % kwshrink with unknown file u
 cp a u
 hg --verbose kwshrink
 echo % cat
 cat sym a b
 echo % hg cat
 hg cat sym a b
 echo
 rm $HGRCPATH
 echo % cat
 cat sym a b
 echo % hg cat
 hg cat sym a b
 echo

tests/test-keyword.out

@@ -1,385 +1,397 b''
 % help
 keyword extension - keyword expansion in local repositories
 
 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.
 
 Configuration is done in the [keyword] and [keywordmaps] sections
 of hgrc files.
 
 Example:
 
     [keyword]
     # expand keywords in every python file except those matching "x*"
     **.py =
     x*    = ignore
 
 Note: the more specific you are in your filename patterns
       the less you lose speed in huge repos.
 
 For [keywordmaps] template mapping and expansion demonstration and
 control run "hg kwdemo".
 
 An additional date template filter {date|utcdate} is provided.
 
 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 config changes.
 
 Before changing/disabling active keywords, run "hg kwshrink" to avoid
 the risk of inadvertedly storing expanded keywords in the change history.
 
 To force expansion after enabling it, or a configuration change, run
 "hg kwexpand".
 
 Also, when committing with the record extension or using mq's qrecord, be aware
 that keywords cannot be updated. Again, run "hg kwexpand" on the files in
 question to update keyword expansions after all changes have been checked in.
 
 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.
 
 list of commands:
 
  kwdemo     print [keywordmaps] configuration and an expansion example
  kwexpand   expand keywords in working directory
  kwfiles    print files currently configured for keyword expansion
  kwshrink   revert expanded keywords in working directory
 
 use "hg -v help keyword" to show aliases and global options
 % hg kwdemo
 [extensions]
 hgext.keyword = 
 [keyword]
 * = 
 b = ignore
 demo.txt = 
 [keywordmaps]
 RCSFile = {file|basename},v
 Author = {author|user}
 Header = {root}/{file},v {node|short} {date|utcdate} {author|user}
 Source = {root}/{file},v
 Date = {date|utcdate}
 Id = {file|basename},v {node|short} {date|utcdate} {author|user}
 Revision = {node|short}
 $RCSFile: demo.txt,v $
 $Author: test $
 $Header: /TMP/demo.txt,v xxxxxxxxxxxx 2000/00/00 00:00:00 test $
 $Source: /TMP/demo.txt,v $
 $Date: 2000/00/00 00:00:00 $
 $Id: demo.txt,v xxxxxxxxxxxx 2000/00/00 00:00:00 test $
 $Revision: xxxxxxxxxxxx $
 [extensions]
 hgext.keyword = 
 [keyword]
 * = 
 b = ignore
 demo.txt = 
 [keywordmaps]
 Branch = {branches}
 $Branch: demobranch $
 % kwshrink should exit silently in empty/invalid repo
 % cat
 expand $Id$
 do not process $Id:
 xxx $
 expand $Id$
 do not process $Id:
 xxx $
 ignore $Id$
 % addremove
 adding a
 adding b
 adding sym
 % status
 A a
 A b
 A sym
 % default keyword expansion including commit hook
 % interrupted commit should not change state or run commit hook
 a
 b
 sym
 transaction abort!
 rollback completed
 abort: empty commit message
 % status
 A a
 A b
 A sym
 % commit
 a
 b
 sym
 overwriting a expanding keywords
 running hook commit.test: cp a hooktest
 % status
 ? hooktest
 % identify
 f782df5f9602
 % cat
 expand $Id: a,v f782df5f9602 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 expand $Id: a,v f782df5f9602 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 ignore $Id$
 % hg cat
 expand $Id: a,v f782df5f9602 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 ignore $Id$
 a
 % diff a hooktest
 % removing commit hook from config
+% bundle
+1 changesets found
+% pull from bundle
+pulling from ../kw.hg
+requesting all changes
+adding changesets
+adding manifests
+adding file changes
+added 1 changesets with 3 changes to 3 files
+3 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % touch
 % status
 % update
 3 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % cat
 expand $Id: a,v f782df5f9602 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 expand $Id: a,v f782df5f9602 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 ignore $Id$
 % check whether expansion is filewise
 % commit c
 adding c
 % force expansion
 overwriting a expanding keywords
 overwriting c expanding keywords
 % compare changenodes in a c
 expand $Id: a,v f782df5f9602 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 $Id: c,v ba4426d1938e 1970/01/01 00:00:01 user $
 tests for different changenodes
+% qinit -c
 % qimport
+% qcommit
 % keywords should not be expanded in patch
 # HG changeset patch
 # User User Name <[e-mail]>
 # Date 1 0
 # Node ID ba4426d1938ec9673e03ab274d88c44e24618f7f
 # Parent  f782df5f9602483b4e51c31a12315f353bba380c
 cndiff
 
 diff -r f782df5f9602 -r ba4426d1938e 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
 % qpop
 Patch queue now empty
 % qgoto - should imply qpush
 applying mqtest.diff
 Now at: mqtest.diff
 % cat
 $Id: c,v ba4426d1938e 1970/01/01 00:00:01 user $
 tests for different changenodes
 % qpop and move on
 Patch queue now empty
 % copy
 % kwfiles added
 a
 c
 % commit
 c
  c: copy a:0045e12f6c5791aac80ca6cbfd97709a88307292
 overwriting c expanding keywords
 % cat a c
 expand $Id: a,v f782df5f9602 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 expand $Id: c,v 0ba462c0f077 1970/01/01 00:00:01 user $
 do not process $Id:
 xxx $
 % touch copied c after 1 second
 % status
 % kwfiles
 a
 c
 % diff --rev
 diff -r f782df5f9602 c
 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
 @@ -0,0 +1,3 @@
 +expand $Id$
 +do not process $Id:
 +xxx $
 % rollback
 rolling back last transaction
 % status
 A c
 % update -C
 0 files updated, 0 files merged, 1 files removed, 0 files unresolved
 % custom keyword expansion
 % try with kwdemo
 [extensions]
 hgext.keyword = 
 [keyword]
 * = 
 b = ignore
 demo.txt = 
 [keywordmaps]
 Xinfo = {author}: {desc}
 $Xinfo: test: hg keyword config and expansion example $
 % cat
 expand $Id: a,v f782df5f9602 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 expand $Id: a,v f782df5f9602 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 ignore $Id$
 % hg cat
 expand $Id: a f782df5f9602 Thu, 01 Jan 1970 00:00:00 +0000 user $
 do not process $Id:
 xxx $
 ignore $Id$
 a
 % interrupted commit should not change state
 transaction abort!
 rollback completed
 abort: empty commit message
 % status
 M a
 ? log
 % commit
 a
 overwriting a expanding keywords
 % status
 % cat
 expand $Id: a 0729690beff6 Thu, 01 Jan 1970 00:00:02 +0000 user $
 do not process $Id:
 xxx $
 $Xinfo: User Name <[e-mail]>: firstline $
 expand $Id: a 0729690beff6 Thu, 01 Jan 1970 00:00:02 +0000 user $
 do not process $Id:
 xxx $
 $Xinfo: User Name <[e-mail]>: firstline $
 ignore $Id$
 % hg cat
 expand $Id: a 0729690beff6 Thu, 01 Jan 1970 00:00:02 +0000 user $
 do not process $Id:
 xxx $
 $Xinfo: User Name <[e-mail]>: firstline $
 ignore $Id$
 a
 % remove
 % status
 % rollback
 rolling back last transaction
 % status
 R a
 % revert a
 % cat a
 expand $Id: a 0729690beff6 Thu, 01 Jan 1970 00:00:02 +0000 user $
 do not process $Id:
 xxx $
 $Xinfo: User Name <[e-mail]>: firstline $
 % clone to test incoming
 requesting all changes
 adding changesets
 adding manifests
 adding file changes
 added 1 changesets with 3 changes to 3 files
 3 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % incoming
 comparing with test-keyword/Test
 searching for changes
 changeset:   1:0729690beff6
 tag:         tip
 user:        User Name <[e-mail]>
 date:        Thu Jan 01 00:00:02 1970 +0000
 summary:     firstline
 
 % commit rejecttest
 a
 overwriting a expanding keywords
 % export
 % import
 applying ../rejecttest.diff
 % cat
 expand $Id: a 82983f13f138 Thu, 01 Jan 1970 00:00:03 +0000 user $ rejecttest
 do not process $Id: rejecttest
 xxx $
 $Xinfo: User Name <[e-mail]>: rejects? $
 expand $Id: a 82983f13f138 Thu, 01 Jan 1970 00:00:03 +0000 user $ rejecttest
 do not process $Id: rejecttest
 xxx $
 $Xinfo: User Name <[e-mail]>: rejects? $
 ignore $Id$
 
 % rollback
 rolling back last transaction
 % clean update
 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % kwexpand/kwshrink on selected files
 % copy a x/a
 % kwexpand a
 overwriting a expanding keywords
 % kwexpand x/a should abort
 abort: outstanding uncommitted changes in given files
 x/a
  x/a: copy a:779c764182ce5d43e2b1eb66ce06d7b47bfe342e
 overwriting x/a expanding keywords
 % cat a
 expand $Id: x/a f27c134d2d9b 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
 overwriting x/a shrinking keywords
 % cat a
 expand $Id$
 do not process $Id:
 xxx $
 $Xinfo$
 % kwexpand nonexistent
 nonexistent: No such file or directory
 % switch off expansion
 % kwshrink with unknown file u
 overwriting a shrinking keywords
 overwriting x/a shrinking keywords
 % cat
 expand $Id$
 do not process $Id:
 xxx $
 $Xinfo$
 expand $Id$
 do not process $Id:
 xxx $
 $Xinfo$
 ignore $Id$
 % hg cat
 expand $Id: a 0729690beff6 Thu, 01 Jan 1970 00:00:02 +0000 user $
 do not process $Id:
 xxx $
 $Xinfo: User Name <[e-mail]>: firstline $
 ignore $Id$
 a
 % cat
 expand $Id$
 do not process $Id:
 xxx $
 $Xinfo$
 expand $Id$
 do not process $Id:
 xxx $
 $Xinfo$
 ignore $Id$
 % hg cat
 expand $Id$
 do not process $Id:
 xxx $
 $Xinfo$
 ignore $Id$
 a