Parcourir la source

[2669] Update check_valgrind.h documentation

Jelte Jansen il y a 12 ans
Parent
commit
10cbf4c33a
1 fichiers modifiés avec 5 ajouts et 0 suppressions
  1. 5 0
      src/lib/util/unittests/check_valgrind.h

+ 5 - 0
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