README
author C?dric Duval <cedricduval@free.fr>
Mon, 22 Jun 2009 15:48:08 +0200
branchstable
changeset 584 763d20224433
parent 562 b1aa7b64890b
child 886 a8ae86023c67
permissions -rw-r--r--
extensions: improve the consistency of synopses Trying as much as possible to consistently: - use a present tense predicate followed by a direct object - verb referring directly to the functionality provided (ie. not "add command that does this" but simple "do that") - keep simple and to the point, leaving details for the long help (width is tight, possibly even more so for translations) Thanks to timeless, Martin Geisler, Rafael Villar Burke, Dan Villiom Podlaski Christiansen and others for the helpful suggestions. [ original upstream message ]
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
561
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
     6
CAVEAT: Please use the keyword extension distributed with
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
     7
Mercurial > 1.0.2!
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
     8
For Mercurial 0.9.2 to 1.0.2 install the 0.9.2compat branch.
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
     9
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
diff changeset
    10
The default and stable branches are meant for development.
efeb09cb3760 Refer users to distribution or 0.9.2compat branch
Christian Ebert <blacktrash@gmx.net>
parents: 321
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
562
b1aa7b64890b Add run-tests.py from main and update README
Christian Ebert <blacktrash@gmx.net>
parents: 561
diff changeset
    15
Run "python setup.py install".
190
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    16
See also "pyton setup.py --help".
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    17
Then add the line:
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
keyword = /path/to/hgkw/keyword.py
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, where /path/to/ is somewhere in your $PYTHONPATH.
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    23
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    24
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    25
first steps and online help
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    26
---------------------------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    27
321
ce5474dd2a9a README: fix help instruction
Christian Ebert <blacktrash@gmx.net>
parents: 239
diff changeset
    28
$ hg help keyword 
190
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    29
$ hg kwdemo
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    30
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    31
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    32
testing
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    33
-------
100d35923d5f Add README
Christian Ebert <blacktrash@gmx.net>
parents:
diff changeset
    34
562
b1aa7b64890b Add run-tests.py from main and update README
Christian Ebert <blacktrash@gmx.net>
parents: 561
diff changeset
    35
$ cd tests
b1aa7b64890b Add run-tests.py from main and update README
Christian Ebert <blacktrash@gmx.net>
parents: 561
diff changeset
    36
$ python run-tests.py --with-hg=/path/to/hg test-keyword