README
author Christian Ebert <blacktrash@gmx.net>
Fri, 05 Oct 2007 14:52:39 +0200
changeset 255 c4f37735be9b
parent 239 a0b8165fcec9
child 321 ce5474dd2a9a
permissions -rw-r--r--
Turn off debug while expanding We don't need templates like file_add etc. as keywords a file specific. Turning off debug avoids accidental expansion of such templates. As a side effect it speeds up expansion when running hg --debug. Functionality of _ctxnode now in new _substitute function.

$Id$

keyword extension for Mercurial SCM
===================================

install
-------

Either copy hgkw/keyword.py into the hgext directory of your
Mercurial installation.
Then add the lines:

[extensions]
hgext.keyword =

to your hgrc file.

Or run "python setup.py install".
See also "pyton setup.py --help".
Then add the line:

[extensions]
keyword = /path/to/hgkw/keyword.py

to your hgrc, where /path/to/ is somewhere in your $PYTHONPATH.


first steps and online help
---------------------------

$ hg keyword help
$ hg kwdemo


testing
-------

Copy hgkw/keyword.py into the hgext directory of your Mercurial
source tree. Copy tests/test-keyword, tests/test-keyword.out into
the tests directory of your Mercurial source tree. Change to that
directory and run:

$ python run-tests.py test-keyword

and then keep your fingers crossed ...