keyword: remove mq commands from restricted list

Monkeypatching patch.diff takes care of this since 911f5be5d159.

Test mq more thoroughly by loosening [keywordmaps] and comparing
the output of hg cat with keyword expansion enabled and disabled.

hgext/keyword.py

@@ -1,521 +1,520 b''
 # keyword.py - $Keyword$ expansion for Mercurial
 #
 # Copyright 2007-2010 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 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://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.
 
 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 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.
 
 An additional date template filter {date|utcdate} is provided. It
 returns a date like "2006/09/18 15:13:13".
 
 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 inadvertently 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, dispatch, filelog, revlog, extensions
 from mercurial import patch, localrepo, templater, templatefilters, util, match
 from mercurial.hgweb import webcommands
 from mercurial.node import nullid
 from mercurial.i18n import _
 import re, shutil, tempfile
 
 commands.optionalrepo += ' kwdemo'
 
 # hg commands that do not act on keywords
 nokwcommands = ('add addremove annotate bundle copy export grep incoming init'
                 ' log outgoing push rename rollback 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 record resolve qfold qimport qnew qpush qrefresh qrecord'
-              ' transplant')
+restricted = 'merge record qrecord resolve transplant'
 
 # provide cvs-like UTC date filter
 utcdate = lambda x: util.datestr((x[0], 0), '%Y/%m/%d %H:%M:%S')
 
 # 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',
         '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}',
     }
 
     def __init__(self, ui, repo):
         self.ui = ui
         self.repo = repo
         self.match = match.match(repo.root, '', [],
                                  kwtools['inc'], kwtools['exc'])
         self.restrict = kwtools['hgcmd'] in restricted.split()
 
         kwmaps = self.ui.configitems('keywordmaps')
         if kwmaps: # override default templates
             self.templates = dict((k, templater.parsestring(v, False))
                                   for k, v in 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
 
     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, '', False)
             ct.use_template(self.templates[kw])
             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 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.repo.filectx(path, fileid=node).changectx()
             return self.substitute(data, path, ctx, self.re_kw.sub)
         return data
 
     def iskwfile(self, path, flagfunc):
         '''Returns true if path matches [keyword] pattern
         and is not a symbolic link.
         Caveat: localrepository._link fails on Windows.'''
         return self.match(path) and not 'l' in flagfunc(path)
 
     def overwrite(self, node, expand, candidates):
         '''Overwrites selected files expanding/shrinking keywords.'''
         ctx = self.repo[node]
         mf = ctx.manifest()
         if node is not None:     # commit
             candidates = [f for f in ctx.files() if f in mf]
         candidates = [f for f in candidates if self.iskwfile(f, ctx.flags)]
         if candidates:
             self.restrict = True # do not expand when reading
             msg = (expand and _('overwriting %s expanding keywords\n')
                    or _('overwriting %s shrinking keywords\n'))
             for f in candidates:
                 fp = self.repo.file(f)
                 data = fp.read(mf[f])
                 if util.binary(data):
                     continue
                 if expand:
                     if node is None:
                         ctx = self.repo.filectx(f, fileid=mf[f]).changectx()
                     data, found = self.substitute(data, f, ctx,
                                                   self.re_kw.subn)
                 else:
                     found = self.re_kw.search(data)
                 if found:
                     self.ui.note(msg % f)
                     self.repo.wwrite(f, data, mf.flags(f))
                     if node is None:
                         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.match(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.match(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:
         return repo.status(match=cmdutil.match(repo, 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.'''
     if repo.dirstate.parents()[1] != nullid:
         raise util.Abort(_('outstanding uncommitted merge'))
     kwt = kwtools['templater']
     wlock = repo.wlock()
     try:
         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'))
         kwt.overwrite(None, expand, clean)
     finally:
         wlock.release()
 
 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(ui, tmpdir, True)
     ui.setconfig('keyword', fn, '')
 
     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:
             ui.status(_('\toverriding default template maps\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'):
         ui.status(_('\n\tconfiguration using default keyword template maps\n'))
         kwmaps = kwtemplater.templates
         if uikwmaps:
             ui.status(_('\tdisabling current template maps\n'))
             for k, v in kwmaps.iteritems():
                 ui.setconfig('keywordmaps', k, v)
     else:
         ui.status(_('\n\tconfiguration using current keyword template maps\n'))
         kwmaps = dict(uikwmaps) or kwtemplater.templates
 
     uisetup(ui)
     reposetup(ui, repo)
     ui.write('[extensions]\nkeyword =\n')
     demoitems('keyword', ui.configitems('keyword'))
     demoitems('keywordmaps', kwmaps.iteritems())
     keywords = '$' + '$\n$'.join(sorted(kwmaps.keys())) + '$\n'
     repo.wopener(fn, 'w').write(keywords)
     repo.add([fn])
     ui.note(_('\nkeywords written to %s:\n') % fn)
     ui.note(keywords)
     repo.dirstate.setbranch('demobranch')
     for name, cmd in ui.configitems('hooks'):
         if name.split('.', 1)[0].find('commit') > -1:
             repo.ui.setconfig('hooks', name, '')
     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)
 
 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)
 
 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']
     status = _status(ui, repo, 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)
     wctx = repo[None]
     kwfiles = [f for f in files if kwt.iskwfile(f, wctx.flags)]
     kwunknown = [f for f in unknown if kwt.iskwfile(f, wctx.flags)]
     if not opts.get('ignore') or opts.get('all'):
         showfiles = kwfiles, 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])
     for char, filenames in zip('KkIi', showfiles):
         fmt = (opts.get('all') or ui.verbose) and '%s %%s\n' % char or '%s\n'
         for f in filenames:
             ui.write(fmt % repo.pathto(f, cwd))
 
 def shrink(ui, repo, *pats, **opts):
     '''revert expanded keywords in the 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(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 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, *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
             kwt.overwrite(n, True, None)
             return n
 
     # monkeypatches
     def kwpatchfile_init(orig, self, ui, fname, opener,
                          missing=False, eolmode=None):
         '''Monkeypatch/wrap patch.patchfile.__init__ to avoid
         rejects or conflicts due to expanded keywords in working dir.'''
         orig(self, ui, fname, opener, missing, 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):
         '''Monkeypatch patch.diff to avoid expansion except when
         comparing against working dir.'''
         if node2 is not None:
             kwt.match = util.never
         elif node1 is not None and node1 != repo['.'].node():
             kwt.restrict = True
         return orig(repo, node1, node2, match, changes, opts)
 
     def kwweb_skip(orig, web, req, tmpl):
         '''Wraps webcommands.x turning off keyword expansion.'''
         kwt.match = util.never
         return orig(web, req, tmpl)
 
     repo.__class__ = kwrepo
 
     extensions.wrapfunction(patch.patchfile, '__init__', kwpatchfile_init)
     if not kwt.restrict:
         extensions.wrapfunction(patch, 'diff', kw_diff)
     for c in 'annotate changeset rev filediff diff'.split():
         extensions.wrapfunction(webcommands, c, kwweb_skip)
 
 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', 'unknown', None, _('only show unknown (not tracked) files')),
          ] + commands.walkopts,
          _('hg kwfiles [OPTION]... [FILE]...')),
     'kwshrink': (shrink, commands.walkopts,
                  _('hg kwshrink [OPTION]... [FILE]...')),
 }

tests/test-keyword

@@ -1,372 +1,376 b''
 #!/bin/sh
 
 cat <<EOF >> $HGRCPATH
 [extensions]
 keyword =
 mq =
 notify =
 transplant =
 EOF
 
 # demo before [keyword] files are set up
 # would succeed without uisetup otherwise
 echo % hg kwdemo
 hg --quiet kwdemo \
 | 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}"
 
 cat <<EOF >> $HGRCPATH
 [keyword]
-* =
+** =
 b = ignore
 [hooks]
 commit=
 commit.test=cp a hooktest
 EOF
 
 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 % no kwfiles
 hg kwfiles
 echo % untracked candidates
 hg -v kwfiles --unknown
 
 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 -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 '/^Content-Type:/,/^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 -C
 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 % init --mq
 hg init --mq
 echo % qimport
 hg qimport -r tip -n mqtest.diff
 echo % commit --mq
 hg commit --mq -m 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 % hg cat
+hg cat c
+echo % keyword should not be expanded in filelog
+hg --config 'extensions.keyword=!' 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 % ignored files
 hg -v kwfiles --ignore
 echo % all files
 hg kwfiles --all
 
 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 % verify
 hg verify
 
 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 % hg serve
 hg serve -p $HGPORT -d --pid-file=hg.pid -A access.log -E errors.log
 cat hg.pid >> $DAEMON_PIDS
 echo % expansion
 echo % hgweb file
 ("$TESTDIR/get-with-headers.py" localhost:$HGPORT '/file/tip/a/?style=raw')
 echo % no expansion
 echo % hgweb annotate
 ("$TESTDIR/get-with-headers.py" localhost:$HGPORT '/annotate/tip/a/?style=raw')
 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
 
 echo % merge/resolve
 echo '$Id$' > m
 hg add m
 hg commit -m 4kw 
 echo foo >> m
 hg commit -m 5foo
 echo % simplemerge
 hg update 4
 echo foo >> m
 hg commit -m 6foo
 hg merge
 hg commit -m simplemerge
 cat m
 echo % conflict
 hg update 4
 echo bar >> m
 hg commit -m 8bar
 hg merge
 echo % keyword stays outside conflict zone
 cat m
 echo % resolve to local
 HGMERGE=internal:local hg resolve -a
 hg commit -m localresolve
 cat m
 
 echo % test restricted mode with transplant -b
 hg update 6
 hg branch foo
 mv a a.bak
 echo foobranch > a
 cat a.bak >> a
 rm a.bak
 hg commit -m 9foobranch
 hg update default
 hg -y transplant -b foo tip
 echo % no expansion in changeset
 hg tip -p
 echo % expansion in file
 head -n 2 a
 hg -q rollback
 hg -q update -C
 
 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

tests/test-keyword.out

@@ -1,480 +1,486 b''
 % hg kwdemo
 [extensions]
 keyword =
 [keyword]
 demo.txt = 
 [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: 2000/00/00 00:00:00 $
 $Header: /TMP/demo.txt,v xxxxxxxxxxxx 2000/00/00 00:00:00 test $
 $Id: demo.txt,v xxxxxxxxxxxx 2000/00/00 00:00:00 test $
 $RCSFile: demo.txt,v $
 $RCSfile: demo.txt,v $
 $Revision: xxxxxxxxxxxx $
 $Source: /TMP/demo.txt,v $
 [extensions]
 keyword =
 [keyword]
 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$
 % no kwfiles
 % untracked candidates
 k a
 % 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
 abort: empty commit message
 % status
 A a
 A b
 % commit
 a
 b
 overwriting a expanding keywords
 running hook commit.test: cp a hooktest
 committed changeset 1:ef63ca68695bc9495032c6fda1350c71e6d256e9
 % 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
 % init --mq
 % qimport
 % commit --mq
 % 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
 popping mqtest.diff
 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
+% hg cat
+$Id: c,v 40a904bbbe4c 1970/01/01 00:00:01 user $
+tests for different changenodes
+% keyword should not be expanded in filelog
+$Id$
+tests for different changenodes
 % qpop and move on
 popping mqtest.diff
 patch queue now empty
 % copy
 % kwfiles added
 a
 c
 % commit
 c
  c: copy a:0045e12f6c5791aac80ca6cbfd97709a88307292
 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
 % status
 % kwfiles
 a
 c
 % ignored files
 I b
 I sym
 % all files
 K a
 K c
 I b
 I sym
 % 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 to revision 2 (undo commit)
 % status
 A c
 % update -C
 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
 % custom keyword expansion
 % try with kwdemo
 [extensions]
 keyword =
 [keyword]
-* = 
+** = 
 b = ignore
 demo.txt = 
 [keywordmaps]
 Xinfo = {author}: {desc}
 $Xinfo: test: hg keyword configuration 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
 abort: empty commit message
 % status
 M a
 ? c
 ? log
 % commit
 a
 overwriting a expanding keywords
 committed changeset 2:bb948857c743469b22bbf51f7ec8112279ca5d83
 % status
 ? c
 % verify
 checking changesets
 checking manifests
 crosschecking files in changesets and manifests
 checking files
 3 files, 3 changesets, 4 total revisions
 % 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
 committed changeset 3:d14c712653769de926994cf7fbb06c8fbd68f012
 % status
 ? c
 % rollback
 rolling back to revision 3 (undo commit)
 % status
 R a
 ? c
 % 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 to branch default
 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
 committed changeset 2:85e279d709ffc28c9fdd1b868570985fc3d87082
 % 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 to revision 3 (undo commit)
 % 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
 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
 overwriting x/a shrinking keywords
 % cat a
 expand $Id$
 do not process $Id:
 xxx $
 $Xinfo$
 % kwexpand nonexistent
 nonexistent:
 % hg serve
 % expansion
 % hgweb file
 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 $
 % no expansion
 % hgweb annotate
 200 Script output follows
 
 
 user@1: expand $Id$
 user@1: do not process $Id:
 user@1: xxx $
 user@2: $Xinfo$
 
 
 
 
 % hgweb changeset
 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$
 
 % hgweb filediff
 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$
 
 
 
 
 % errors encountered
 % merge/resolve
 % simplemerge
 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 created new head
 0 files updated, 0 files merged, 0 files removed, 0 files unresolved
 (branch merge, don't forget to commit)
 $Id: m 27d48ee14f67 Thu, 01 Jan 1970 00:00:00 +0000 test $
 foo
 % conflict
 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 created new head
 merging m
 warning: conflicts during merge.
 merging m failed!
 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
 % keyword stays outside conflict zone
 $Id$
 <<<<<<< local
 bar
 =======
 foo
 >>>>>>> other
 % resolve to local
 $Id: m 41efa6d38e9b Thu, 01 Jan 1970 00:00:00 +0000 test $
 bar
 % test restricted mode with transplant -b
 1 files updated, 0 files merged, 0 files removed, 0 files unresolved
 marked working directory as branch foo
 created new head
 2 files updated, 0 files merged, 0 files removed, 0 files unresolved
 applying 4aa30d025d50
 4aa30d025d50 transplanted to 5a4da427c162
 % no expansion in changeset
 changeset:   11:5a4da427c162
 tag:         tip
 parent:      9:41efa6d38e9b
 user:        test
 date:        Thu Jan 01 00:00:00 1970 +0000
 summary:     9foobranch
 
 diff -r 41efa6d38e9b -r 5a4da427c162 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 $
 
 % expansion in file
 foobranch
 expand $Id: a 5a4da427c162 Thu, 01 Jan 1970 00:00:00 +0000 test $
 % switch off expansion
 % kwshrink with unknown file u
 overwriting a shrinking keywords
 overwriting m 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