README
author Idan Kamara <idankk86@gmail.com>
Wed, 12 Oct 2011 22:01:14 +0200
branchstable
changeset 987 5fc540826f9f
parent 886 a8ae86023c67
child 984 a4ea5c2d3ff3
child 1345 ea8abd9436ee
permissions -rw-r--r--
tests: add support for inline doctests in test files This adds doctest like syntax to .t files, that can be interleaved with regular shell code: $ echo -n a > file >>> print open('file').read() a >>> open('file', 'a').write('b') $ cat file ab The syntax is exactly the same as regular doctests, so multiline statements look like this: >>> for i in range(3): ... print i 0 1 2 Each block has its own context, i.e.: >>> x = 0 >>> print x 0 $ echo 'foo' foo >>> print x will result in a NameError. Errors are displayed in standard doctest format: >>> print 'foo' bar --- /home/idan/dev/hg/default/tests/test-test.t +++ /home/idan/dev/hg/default/tests/test-test.t.err @@ -2,3 +2,16 @@ > >>> print 'foo' > bar > EOF + ********************************************************************** + File "/tmp/tmps8X_0ohg-tst", line 1, in tmps8X_0ohg-tst + Failed example: + print 'foo' + Expected: + bar + Got: + foo + ********************************************************************** + 1 items had failures: + 1 of 1 in tmps8X_0ohg-tst + ***Test Failed*** 1 failures. + [1] As for the implementation, it's quite simple: when the test runner sees a line starting with '>>>' it converts it, and all subsequent lines until the next line that begins with '$' to a 'python -m heredoctest <<EOF' call with the proper heredoc to follow. So if we have this test file: >>> for c in 'abcd': ... print c a b c d $ echo foo foo It gets converted to: $ python -m heredoctest <<EOF > >>> for c in 'abcd': > ... print c > a > b > c > d > EOF $ echo foo foo And then processed like every other test file by converting it to a sh script. [ original upstream message ]

$Id$

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

CAVEAT: Please use the keyword extension distributed with
Mercurial > 1.0.2!
For Mercurial 0.9.2 to 1.0.2 install the 0.9.2compat branch.

The default and stable branches are meant for development.

install
-------

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 help keyword 
$ hg kwdemo


testing
-------

$ cd tests
$ ./run-tests.py --with-hg=/path/to/hg