From 3d745b1d352e0222b68f83dbd7a242d490655bab Mon Sep 17 00:00:00 2001 From: Matthias Maier Date: Wed, 9 Feb 2022 04:37:17 -0600 Subject: [PATCH] doc: Update documentation --- cmake/macros/macro_deal_ii_add_test.cmake | 13 ++++++++----- cmake/macros/macro_deal_ii_pickup_tests.cmake | 11 +++++++---- doc/developers/testsuite.html | 12 +++++++----- doc/users/testsuite.html | 10 ++++++---- 4 files changed, 28 insertions(+), 18 deletions(-) diff --git a/cmake/macros/macro_deal_ii_add_test.cmake b/cmake/macros/macro_deal_ii_add_test.cmake index 39d920fb21..281a696bbc 100644 --- a/cmake/macros/macro_deal_ii_add_test.cmake +++ b/cmake/macros/macro_deal_ii_add_test.cmake @@ -77,13 +77,16 @@ # test variant configures a larger number of MPI ranks (via # .mpirun=N. in the output file) than this limit the test will be # dropped. The special value 0 enforces no limit. Defaults to 0. - +# # TEST_THREAD_LIMIT # - Specifies the maximal number of worker threads that can should be -# used by the threading backend. Note that individual tests might -# exceed this limit by calling MultithreadInfo::set_thread_limit(), or -# by manually creating additional threads. The special value 0 -# enforces no limit. Defaults to 0. +# used by the threading backend. If a test variant configures a +# larger number of threads (via .threads=N. in the output file) than +# this limit the test will be dropped. Note that individual tests +# might exceed this limit by calling +# MultithreadInfo::set_thread_limit(), or by manually creating +# additional threads. The special value 0 enforces no limit. Defaults +# to 0. # # Usage: # DEAL_II_ADD_TEST(category test_name comparison_file) diff --git a/cmake/macros/macro_deal_ii_pickup_tests.cmake b/cmake/macros/macro_deal_ii_pickup_tests.cmake index 8651614cea..4401839a1c 100644 --- a/cmake/macros/macro_deal_ii_pickup_tests.cmake +++ b/cmake/macros/macro_deal_ii_pickup_tests.cmake @@ -43,10 +43,13 @@ # dropped. The special value 0 enforces no limit. Defaults to 0. # TEST_THREAD_LIMIT # - Specifies the maximal number of worker threads that can should be -# used by the threading backend. Note that individual tests might -# exceed this limit by calling MultithreadInfo::set_thread_limit(), -# or by manually creating additional threads. The special value 0 -# enforces no limit. Defaults to 0. +# used by the threading backend. If a test variant configures a +# larger number of threads (via .threads=N. in the output file) +# than this limit the test will be dropped. Note that individual +# tests might exceed this limit by calling +# MultithreadInfo::set_thread_limit(), or by manually creating +# additional threads. The special value 0 enforces no limit. +# Defaults to 0. # # TEST_PICKUP_REGEX # - A regular expression to select only a subset of tests during setup. diff --git a/doc/developers/testsuite.html b/doc/developers/testsuite.html index ae5fb39dac..445b9d3956 100644 --- a/doc/developers/testsuite.html +++ b/doc/developers/testsuite.html @@ -118,10 +118,12 @@ TEST_MPI_RANK_LIMIT TEST_THREAD_LIMIT - Specifies the maximal number of worker threads that can should be - used by the threading backend. Note that individual tests might - exceed this limit by calling MultithreadInfo::set_thread_limit(), or - by manually creating additional threads. The special value 0 - enforces no limit. Defaults to 0. + used by the threading backend. If a test variant configures a larger + number of threads (via .threads=N. in the output file) than this limit + the test will be dropped. Note that individual tests might exceed this + limit by calling MultithreadInfo::set_thread_limit(), or by manually + creating additional threads. The special value 0 enforces no limit. + Defaults to 0. TEST_PICKUP_REGEX - A regular expression to select only a subset of tests during setup. @@ -473,7 +475,7 @@ category/test.output just category/test.output. In pseudo code: 
 category/test.[with_<string>(<=|>=|=|<|>)<on|off|version>.]*
-              [mpirun=<x>.][expect=<y>.][binary.][<debug|release>.]output
+              [mpirun=<N|all>.][threads=<N|all>.][expect=<y>.][binary.][<debug|release>.]output
Normally, a test will be set up so that it runs twice, once in debug and once in release configuration. diff --git a/doc/users/testsuite.html b/doc/users/testsuite.html index dfbf6de5c0..ccc40b6819 100644 --- a/doc/users/testsuite.html +++ b/doc/users/testsuite.html @@ -323,10 +323,12 @@ TEST_MPI_RANK_LIMIT TEST_THREAD_LIMIT - Specifies the maximal number of worker threads that can should be - used by the threading backend. Note that individual tests might - exceed this limit by calling MultithreadInfo::set_thread_limit(), or - by manually creating additional threads. The special value 0 - enforces no limit. Defaults to 0. + used by the threading backend. If a test variant configures a larger + number of threads (via .threads=N. in the output file) than this limit + the test will be dropped. Note that individual tests might exceed this + limit by calling MultithreadInfo::set_thread_limit(), or by manually + creating additional threads. The special value 0 enforces no limit. + Defaults to 0.
-- 2.39.5