README
author Christian Ebert <blacktrash@gmx.net>
Thu, 24 Dec 2009 10:54:00 +0000
branch0.9.2compat
changeset 672 0d7642e39cfe
parent 560 42502f8fc5b0
child 984 a4ea5c2d3ff3
permissions -rw-r--r--
(0.9.2compat) do not monkeypatch diff in restricted mode; transplant restricted See 52b03aad673b, 13a6a2c0440f.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
190
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     1
$Id$
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     2
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     3
keyword extension for Mercurial SCM
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     4
===================================
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
     5
560
42502f8fc5b0 (0.9.2compat) document Mercurial version range for standalone extension
Christian Ebert <blacktrash@gmx.net>
parents: 322
diff changeset
     6
[ standalone and backwards compatible version ]
42502f8fc5b0 (0.9.2compat) document Mercurial version range for standalone extension
Christian Ebert <blacktrash@gmx.net>
parents: 322
diff changeset
     7
42502f8fc5b0 (0.9.2compat) document Mercurial version range for standalone extension
Christian Ebert <blacktrash@gmx.net>
parents: 322
diff changeset
     8
CAVEAT: Only use this version with Mercurial 0.9.2 to 1.0.2!
42502f8fc5b0 (0.9.2compat) document Mercurial version range for standalone extension
Christian Ebert <blacktrash@gmx.net>
parents: 322
diff changeset
     9
With Mercurial > 1.0.2 use the extension included in the
42502f8fc5b0 (0.9.2compat) document Mercurial version range for standalone extension
Christian Ebert <blacktrash@gmx.net>
parents: 322
diff changeset
    10
distribution.
42502f8fc5b0 (0.9.2compat) document Mercurial version range for standalone extension
Christian Ebert <blacktrash@gmx.net>
parents: 322
diff changeset
    11
190
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    12
install
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    13
-------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    14
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    15
Either copy hgkw/keyword.py into the hgext directory of your
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    16
Mercurial installation.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    17
Then add the lines:
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    18
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    19
[extensions]
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    20
hgext.keyword =
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    21
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    22
to your hgrc file.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    23
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    24
Or run "python setup.py install".
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    25
See also "pyton setup.py --help".
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    26
Then add the line:
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    27
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    28
[extensions]
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    29
keyword = /path/to/hgkw/keyword.py
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    30
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    31
to your hgrc, where /path/to/ is somewhere in your $PYTHONPATH.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    32
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    33
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    34
first steps and online help
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    35
---------------------------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    36
322
b1ac738404f8 (0.9.2compat) get backwards compatible changes from default branch
Christian Ebert <blacktrash@gmx.net>
parents: 239
diff changeset
    37
$ hg help keyword 
190
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    38
$ hg kwdemo
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    39
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    40
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    41
testing
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    42
-------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    43
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    44
Copy hgkw/keyword.py into the hgext directory of your Mercurial
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    45
source tree. Copy tests/test-keyword, tests/test-keyword.out into
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    46
the tests directory of your Mercurial source tree. Change to that
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    47
directory and run:
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    48
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    49
$ python run-tests.py test-keyword
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    50
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    51
and then keep your fingers crossed ...