Add documentation about how to install and run tests.
This adds some docs on installing dependencies needed to run tests. It's
not totally complete (misses some support for other SCMs), but gives us
Patch by Craig Silverstein, with some ReST fixes by Christian Hammond.
Reviewed at http://reviews.reviewboard.org/r/2996/
Loading branch information
2 changed files
and 0 deletions.
@@ -13,6 +13,7 @@ Contributors:
* Ben Hollis
* Bryan Halter
* Chris Clark
+ * Craig Silverstein
* Dan Savilonis
* Dana Lacoste
* Daniel Cestari
@@ -11,3 +11,49 @@ This consists of the following officially supported tools:
There are also some user-contributed scripts and application plugins in the
contrib directory. See the associated README files for more information.
+This is of interest mostly to developers of rbtools.
+To run all the tests, you will need to install hgsubversion::
+ $ easy_install hgsubversion
+This may need apr-config, also known as apr-1-config, to run. This is
+part of the apache distribution. On ubuntu, you can get it via::
+ $ sudo apt-get install libapr1-dev # also try apache2-dev or httpd-dev
+hgsubversion also requires that you set up an :file:`.hgrc` in your home
+directory with the following contents::
+ hgsvn = /path/to/hgsubversion
+This will be something like
+If you already have an ``[extensions]`` section in your :file:`.hgrc`, just add
+the hgsvn line to it.
+You will also need nose::
+ $ easy_install nose
+ $ nosetests
+from the top of the rbtools directory. You can run nosetests in subdirectories
+to just run the tests in that directory. See `'nosetests --help'` for more