doc: Update documentation

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)

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.

doc/developers/testsuite.html

@@ -118,10 +118,12 @@ <h3>For a build directory</h3>
 
 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 @@ <h3>Restricting tests to build configurations</h3>
       just <code>category/test.output</code>. In pseudo code:
 <pre>
 category/test.[with_&lt;string&gt;(&lt;=|&gt;=|=|&lt;|&gt;)&lt;on|off|version&gt;.]*
-              [mpirun=&lt;x&gt;.][expect=&lt;y&gt;.][binary.][&lt;debug|release&gt;.]output
+              [mpirun=&lt;N|all&gt;.][threads=&lt;N|all&gt;.][expect=&lt;y&gt;.][binary.][&lt;debug|release&gt;.]output
 </pre>
       Normally, a test will be set up so that it runs twice, once in debug and
       once in release configuration.

doc/users/testsuite.html

@@ -323,10 +323,12 @@ <h3>Advanced configuration</h3>
 
 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.</pre>
+    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.</pre>
     <hr />
     <div class="right">
       <a href="http://validator.w3.org/check?uri=referer" target="_top">