From: Sebastian Hahn <sebastian@torproject.org>
Date: Fri, 12 Sep 2014 20:08:27 +0000 (+0200)
Subject: Give an example how to run the unit tests
X-Git-Tag: tor-0.2.6.1-alpha~124
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=84489011480a031e156cdae8ed32dd7597808994;p=thirdparty%2Ftor.git

Give an example how to run the unit tests
---

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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~