aboutsummaryrefslogtreecommitdiff
path: root/doc/HACKING
diff options
context:
space:
mode:
authorSebastian Hahn <sebastian@torproject.org>2014-09-12 22:08:27 +0200
committerSebastian Hahn <sebastian@torproject.org>2014-09-12 22:08:27 +0200
commit84489011480a031e156cdae8ed32dd7597808994 (patch)
treebde66d86ab5baefeb43027a6aba0b296a4353164 /doc/HACKING
parent974f4d2ceb0c494bc5008749928bd2d49317cf0b (diff)
downloadtor-84489011480a031e156cdae8ed32dd7597808994.tar.gz
tor-84489011480a031e156cdae8ed32dd7597808994.zip
Give an example how to run the unit tests
Diffstat (limited to 'doc/HACKING')
-rw-r--r--doc/HACKING16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/HACKING b/doc/HACKING
index 4e9c4e305b..b1733abf4c 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -134,6 +134,22 @@ output directory, use `make coverage-html HTML_COVER_DIR=./funky_new_cov_dir`.
Coverage diffs using lcov are not currently implemented, but are being
investigated (as of July 2014).
+Running the unit tests
+~~~~~~~~~~~~~~~~~~~~~~
+
+To quickly run all tests:
+-----
+ make test
+-----
+
+To selectively run just some tests (the following can be combined
+arbitrarily):
+-----
+ ./src/test/test <name_of_test> [<name of test 2>] ...
+ ./src/test/test <prefix_of_name_of_test>.. [<prefix_of_name_of_test2>..] ...
+ ./src/test/test :<name_of_excluded_test> [:<name_of_excluded_test2]...
+-----
+
Running gcov for unit test coverage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~