Skip to content

Commit b1f4fcd

Browse files
committed
clarify instructions for running tests; fixes #92
1 parent caa2c97 commit b1f4fcd

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

docs/en/developers.rst

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,30 @@ The output version of the documentation ends up in
6464
Running Tests
6565
=============
6666

67-
The test suite for virtualenvwrapper uses `shunit2
68-
<http://shunit2.googlecode.com/>`_ and `tox
69-
<http://codespeak.net/tox>`_. To run the tests under bash, sh, and
70-
zsh for Python 2.4-2.7, use ``tox`` from the top level directory of
71-
the hg repository.
72-
73-
Add new tests by modifying or creating an appropriate script in the
74-
``tests`` directory.
67+
The test suite for virtualenvwrapper uses shunit2_ and tox_. The
68+
shunit2 source is included in the ``tests`` directory, but tox must be
69+
installed separately (``pip install tox``).
70+
71+
To run the tests under bash, zsh, and ksh for Python 2.4 through 2.7,
72+
run ``tox`` from the top level directory of the hg repository.
73+
74+
To run individual test scripts, use a command like::
75+
76+
$ tox tests/test_cd.sh
77+
78+
To run tests under a single version of Python, specify the appropriate
79+
environment when running tox::
80+
81+
$ tox -e py27
82+
83+
Combine the two modes to run specific tests with a single version of
84+
Python::
85+
86+
$ tox -e py27 tests/test_cd.sh
87+
88+
Add new tests by modifying an existing file or creating new script in
89+
the ``tests`` directory.
90+
91+
.. _shunit2: http://shunit2.googlecode.com/
92+
93+
.. _tox: http://codespeak.net/tox

0 commit comments

Comments
 (0)