2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-29 13:07:50 +00:00

[2669] Update check_valgrind.h documentation

This commit is contained in:
Jelte Jansen 2013-02-19 11:46:23 +01:00
parent 24503d327e
commit 10cbf4c33a

View File

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