From 10cbf4c33a915a6287bc8b32b5b3f521b4ced50b Mon Sep 17 00:00:00 2001 From: Jelte Jansen Date: Tue, 19 Feb 2013 11:46:23 +0100 Subject: [PATCH] [2669] Update check_valgrind.h documentation --- src/lib/util/unittests/check_valgrind.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/lib/util/unittests/check_valgrind.h b/src/lib/util/unittests/check_valgrind.h index 80f1f859d1..3837b10ac0 100644 --- a/src/lib/util/unittests/check_valgrind.h +++ b/src/lib/util/unittests/check_valgrind.h @@ -38,6 +38,11 @@ namespace unittests { /// \brief Check if the program is run in valgrind /// +/// This is used to check for valgrind and skip (parts of) tests that fork, +/// such as death tests, and general forking tests, and some threading tests; +/// These tend to cause valgrind to report errors, which would hide other +/// potential valgrind reports. +/// /// \return true if valgrind headers are available, and valgrind is running, /// false if the headers are not available, or if valgrind is not /// running