keyword: disable expansion for annotate

Keyword expansion should not be annotated.
Annotate revision when unexpanded keyword was inserted.

Add test.

hgext/keyword.py

@@ -1,556 +1,563 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.hgweb import webcommands
 from mercurial.node import nullid, hex
 from mercurial.i18n import _
 import re, shutil, tempfile, time
 
 commands.optionalrepo += ' kwdemo'
 
 # hg commands that do not act on keywords
-nokwcommands = ('add addremove bundle copy export grep incoming init'
+nokwcommands = ('add addremove annotate bundle copy export grep incoming init'
                 ' log outgoing push rename rollback tip'
                 ' 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 = '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]))
 
 # make keyword tools accessible
 kwtools = {'templater': None, 'hgcmd': '', 'inc': [], 'exc': ['.hg*']}
 
 
 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):
         self.ui = ui
         self.repo = repo
         self.matcher = util.matcher(repo.root,
                                     inc=kwtools['inc'], exc=kwtools['exc'])[1]
         self.restrict = kwtools['hgcmd'] in restricted.split()
 
         kwmaps = self.ui.configitems('keywordmaps')
         if kwmaps: # override default templates
             kwmaps = [(k, templater.parsestring(v, 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 getnode(self, path, fnode):
         '''Derives changenode from file path and filenode.'''
         # used by kwfilelog.read and kwexpand
         c = context.filectx(self.repo, path, fileid=fnode)
         return c.node()
 
     def substitute(self, data, path, node, subfunc):
         '''Replaces keywords in data with expanded template.'''
         def kwsub(mobj):
             kw = mobj.group(1)
             self.ct.use_template(self.templates[kw])
             self.ui.pushbuffer()
             self.ct.show(changenode=node, root=self.repo.root, file=path)
             ekw = templatefilters.firstline(self.ui.popbuffer())
             return '$%s: %s $' % (kw, ekw)
         return subfunc(kwsub, data)
 
     def expand(self, path, node, data):
         '''Returns data with keywords expanded.'''
         if not self.restrict and self.matcher(path) and not util.binary(data):
             changenode = self.getnode(path, node)
             return self.substitute(data, path, changenode, self.re_kw.sub)
         return data
 
     def iskwfile(self, path, islink):
         '''Returns true if path matches [keyword] pattern
         and is not a symbolic link.
         Caveat: localrepository._link fails on Windows.'''
         return self.matcher(path) and not islink(path)
 
     def overwrite(self, node, expand, files):
         '''Overwrites selected files expanding/shrinking keywords.'''
         ctx = self.repo.changectx(node)
         mf = ctx.manifest()
         if node is not None:     # commit
             files = [f for f in ctx.files() if f in mf]
             notify = self.ui.debug
         else:                    # kwexpand/kwshrink
             notify = self.ui.note
         candidates = [f for f in files if self.iskwfile(f, mf.linkf)]
         if candidates:
             self.restrict = True # do not expand when reading
             candidates.sort()
             action = expand and 'expanding' or 'shrinking'
             for f in candidates:
                 fp = self.repo.file(f)
                 data = fp.read(mf[f])
                 if util.binary(data):
                     continue
                 if expand:
                     changenode = node or self.getnode(f, mf[f])
                     data, found = self.substitute(data, f, changenode,
                                                   self.re_kw.subn)
                 else:
                     found = self.re_kw.search(data)
                 if found:
                     notify(_('overwriting %s %s keywords\n') % (f, action))
                     self.repo.wwrite(f, data, mf.flags(f))
                     self.repo.dirstate.normal(f)
             self.restrict = False
 
     def shrinktext(self, text):
         '''Unconditionally removes all keyword substitutions from text.'''
         return self.re_kw.sub(r'$\1$', text)
 
     def shrink(self, fname, text):
         '''Returns text with all keyword substitutions removed.'''
         if self.matcher(fname) and not util.binary(text):
             return self.shrinktext(text)
         return text
 
     def shrinklines(self, fname, lines):
         '''Returns lines with keyword substitutions removed.'''
         if self.matcher(fname):
             text = ''.join(lines)
             if not util.binary(text):
                 return self.shrinktext(text).splitlines(True)
         return lines
 
     def wread(self, fname, data):
         '''If in restricted mode returns data read from wdir with
         keyword substitutions removed.'''
         return self.restrict and self.shrink(fname, data) or 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)
         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)
         if self.renamed(node):
             t2 = super(kwfilelog, self).read(node)
             return t2 != text
         return revlog.revlog.cmp(self, node, text)
 
 def _status(ui, repo, kwt, *pats, **opts):
     '''Bails out if [keyword] configuration is not active.
     Returns status of working directory.'''
     if kwt:
         matcher = cmdutil.match(repo, pats, opts)
         return repo.status(match=matcher, list_clean=True)
     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.'''
     kwt = kwtools['templater']
     status = _status(ui, repo, 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 in given files'))
     wlock = lock = None
     try:
         wlock = repo.wlock()
         lock = repo.lock()
         kwt.overwrite(None, expand, 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, tmpdir, 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
     uisetup(ui)
     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.
     '''
     kwt = kwtools['templater']
     status = _status(ui, repo, kwt, *pats, **opts)
     modified, added, removed, deleted, unknown, ignored, clean = status
     files = modified + added + clean
     if opts.get('untracked'):
         files += unknown
     files.sort()
     wctx = repo.workingctx()
     islink = lambda p: 'l' in wctx.fileflags(p)
     kwfiles = [f for f in files if kwt.iskwfile(f, islink)]
     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 uisetup(ui):
     '''Collects [keyword] config in kwtools.
     Monkeypatches dispatch._parse if needed.'''
 
     for pat, opt in ui.configitems('keyword'):
         if opt != 'ignore':
             kwtools['inc'].append(pat)
         else:
             kwtools['exc'].append(pat)
 
     if kwtools['inc']:
         def kwdispatch_parse(ui, args):
             '''Monkeypatch dispatch._parse to obtain running hg command.'''
             cmd, func, args, options, cmdoptions = dispatch_parse(ui, args)
             kwtools['hgcmd'] = cmd
             return cmd, func, args, options, cmdoptions
 
         dispatch_parse = dispatch._parse
         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 not kwtools['inc']
             or kwtools['hgcmd'] in nokwcommands.split()
             or '.hg' in util.splitpath(repo.root)
             or repo._url.startswith('bundle:')):
             return
     except AttributeError:
         pass
 
     kwtools['templater'] = kwt = kwtemplater(ui, repo)
 
     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, files=None, text='', user=None, date=None,
                    match=None, 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)
 
                 n = super(kwrepo, self).commit(files, text, user, date, match,
                                                force, force_editor, p1, p2,
                                                extra, empty_ok)
 
                 # restore commit hooks
                 for name, cmd in commithooks.iteritems():
                     ui.setconfig('hooks', name, cmd)
                 if n is not None:
                     kwt.overwrite(n, True, None)
                     repo.hook('commit', node=n, parent1=_p1, parent2=_p2)
                 return n
             finally:
                 del wlock, lock
 
     # monkeypatches
     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)
         # shrink keywords read from working dir
         self.lines = kwt.shrinklines(self.fname, self.lines)
 
     def kw_diff(repo, node1=None, node2=None, match=None,
                 fp=None, changes=None, opts=None):
         '''Monkeypatch patch.diff to avoid expansion except when
         comparing against working dir.'''
         if node2 is not None:
             kwt.matcher = util.never
         elif node1 is not None and node1 != repo.changectx().node():
             kwt.restrict = True
         patch_diff(repo, node1, node2, match, fp, changes, opts)
 
+    def kwweb_annotate(web, req, tmpl):
+        '''Wraps webcommands.annotate turning off keyword expansion.'''
+        kwt.matcher = util.never
+        return webcommands_annotate(web, req, tmpl)
+
     def kwweb_changeset(web, req, tmpl):
         '''Wraps webcommands.changeset turning off keyword expansion.'''
         kwt.matcher = util.never
         return webcommands_changeset(web, req, tmpl)
 
     def kwweb_filediff(web, req, tmpl):
         '''Wraps webcommands.filediff turning off keyword expansion.'''
         kwt.matcher = util.never
         return webcommands_filediff(web, req, tmpl)
 
     repo.__class__ = kwrepo
 
     patchfile_init = patch.patchfile.__init__
     patch_diff = patch.diff
+    webcommands_annotate = webcommands.annotate
     webcommands_changeset = webcommands.changeset
     webcommands_filediff = webcommands.filediff
 
     patch.patchfile.__init__ = kwpatchfile_init
     patch.diff = kw_diff
+    webcommands.annotate = kwweb_annotate
     webcommands.changeset = webcommands.rev = kwweb_changeset
     webcommands.filediff = webcommands.diff = kwweb_filediff
 
 
 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,308 +1,310 b''
 #!/bin/sh
 
 cat <<EOF >> $HGRCPATH
 [extensions]
 hgext.keyword =
 hgext.mq =
 hgext.notify =
 [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-bndl
 cd Test-bndl
 
 echo % kwshrink should exit silently in empty/invalid repo
 hg kwshrink
 
 # Symlinks cannot be created on Windows. The bundle 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/test-keyword.hg" \
     | sed 's/pulling from.*test-keyword.hg/pulling from test-keyword.hg/'
 
 echo 'expand $Id$' > a
 echo 'do not process $Id:' >> a
 echo 'xxx $' >> a
 echo 'ignore $Id$' > b
 echo % cat
 cat 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 debugrebuildstate
 hg --quiet identify
 echo % cat
 cat 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 % notify on pull to check whether keywords stay as is in email
 echo % ie. if patch.diff wrapper acts as it should
 
 cat <<EOF >> $HGRCPATH
 [hooks]
 incoming.notify = python:hgext.notify.hook
 [notify]
 sources = pull
 diffstat = False
 [reposubs]
 * = Test
 EOF
 
 echo % pull from bundle
 hg pull -u ../kw.hg 2>&1 | sed -e '/^Date:/,/^diffs (/ d'
 
 echo % remove notify config
 sed -e '/\[hooks\]/,$ d' $HGRCPATH > $HGRCPATH.nonotify
 mv $HGRCPATH.nonotify $HGRCPATH
 
 echo % touch
 touch a b
 echo % status
 hg status
 
 rm sym a b
 echo % update
 hg update
 echo % cat
 cat 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
 touch c
 echo % status
 hg status
 
 echo % kwfiles
 hg kwfiles
 
 echo % diff --rev
 hg diff --rev 1 | 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 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 a b
 echo % hg cat
 hg cat sym a b
 echo
+echo % annotate
+hg annotate a
 
 echo % remove
 hg debugrebuildstate
 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 -r1 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 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 2>&1 | sed 's/nonexistent:.*/nonexistent:/'
 
 echo % switch off expansion
 echo % kwshrink with unknown file u
 cp a u
 hg --verbose kwshrink
 echo % cat
 cat a b
 echo % hg cat
 hg cat sym a b
 echo
 rm $HGRCPATH
 echo % cat
 cat a b
 echo % hg cat
 hg cat sym a b
 echo
 
 echo % hg serve
 hg serve -p $HGPORT -d --pid-file=hg.pid -A access.log -E errors.log
 cat hg.pid >> $DAEMON_PIDS
 echo % hgweb changeset
 ("$TESTDIR/get-with-headers.py" localhost:$HGPORT '/rev/tip/?style=raw')
 echo % hgweb filediff
 ("$TESTDIR/get-with-headers.py" localhost:$HGPORT '/diff/bb948857c743/a?style=raw')
 echo % errors encountered
 cat errors.log

tests/test-keyword.out

@@ -1,431 +1,436 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
 pulling from test-keyword.hg
 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
 % cat
 expand $Id$
 do not process $Id:
 xxx $
 ignore $Id$
 % addremove
 adding a
 adding b
 % status
 A a
 A b
 % default keyword expansion including commit hook
 % interrupted commit should not change state or run commit hook
 a
 b
 transaction abort!
 rollback completed
 abort: empty commit message
 % status
 A a
 A b
 % commit
 a
 b
 overwriting a expanding keywords
 running hook commit.test: cp a hooktest
 % status
 ? hooktest
 % identify
 ef63ca68695b
 % cat
 expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 ignore $Id$
 % hg cat
 expand $Id: a,v ef63ca68695b 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 ignore $Id$
 a
 % diff a hooktest
 % removing commit hook from config
 % bundle
 2 changesets found
 % notify on pull to check whether keywords stay as is in email
 % ie. if patch.diff wrapper acts as it should
 % pull from bundle
 pulling from ../kw.hg
 requesting all changes
 adding changesets
 adding manifests
 adding file changes
 added 2 changesets with 3 changes to 3 files
 
 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
 
 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
 % remove notify config
 % touch
 % status
 % update
 3 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % cat
 expand $Id: a,v ef63ca68695b 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 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
 % qinit -c
 % qimport
 % qcommit
 % keywords should not be expanded in patch
 # HG changeset patch
 # User User Name <[e-mail]>
 # Date 1 0
 # 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
 % qpop
 Patch queue now empty
 % qgoto - should imply qpush
 applying mqtest.diff
 Now at: mqtest.diff
 % cat
 $Id: c,v 40a904bbbe4c 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 ef63ca68695b 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 expand $Id: c,v e22d299ac0c2 1970/01/01 00:00:01 user $
 do not process $Id:
 xxx $
 % touch copied c
 % status
 % kwfiles
 a
 c
 % diff --rev
 diff -r ef63ca68695b 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 ef63ca68695b 1970/01/01 00:00:00 user $
 do not process $Id:
 xxx $
 ignore $Id$
 % hg cat
 expand $Id: a ef63ca68695b 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 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
 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
+1: expand $Id$
+1: do not process $Id:
+1: xxx $
+2: $Xinfo$
 % remove
 % status
 % rollback
 rolling back last transaction
 % status
 R a
 % revert 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 incoming
 requesting all changes
 adding changesets
 adding manifests
 adding file changes
 added 2 changesets with 3 changes to 3 files
 updating working directory
 3 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % incoming
 comparing with test-keyword/Test
 searching for changes
 changeset:   2:bb948857c743
 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 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$
 
 % 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 cfa68229c116 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:
 % 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$
 ignore $Id$
 % hg cat
 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
 % cat
 expand $Id$
 do not process $Id:
 xxx $
 $Xinfo$
 ignore $Id$
 % hg cat
 expand $Id$
 do not process $Id:
 xxx $
 $Xinfo$
 ignore $Id$
 a
 % hg serve
 % hgweb changeset
 200 Script output follows
 
 
 # HG changeset patch
 # User User Name <[e-mail]>
 # Date 3 0
 # Node ID cfa68229c1167443337266ebac453c73b1d5d16e
 # Parent bb948857c743469b22bbf51f7ec8112279ca5d83
 xa
 
 --- /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$
 
 % hgweb filediff
 200 Script output follows
 
 
 --- 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$
 
 
 
 
 % errors encountered