From: Matthias Maier <tamiko@43-1.org>
Date: Thu, 10 Feb 2022 10:20:59 +0000 (-0600)
Subject: add documentation
X-Git-Tag: v9.4.0-rc1~512^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0818fb6b59c6eae28c21e94cac609f9d93084478;p=dealii.git

add documentation
---

diff --git a/doc/developers/testsuite.html b/doc/developers/testsuite.html
index 445b9d3956..74e7d708cb 100644
--- a/doc/developers/testsuite.html
+++ b/doc/developers/testsuite.html
@@ -475,7 +475,7 @@ category/test.output
       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;N|all&gt;.][threads=&lt;N|all&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|run_only)
 </pre>
       Normally, a test will be set up so that it runs twice, once in debug and
       once in release configuration.
@@ -608,6 +608,20 @@ category/test.output.4
 category/test.expect=run.output
 </pre>
     </p>
+    <p>
+      The testsuite also suppors the special file ending
+      <code>.run_only</code> that indicates that the diff stage should be
+      skipped in order to reach the <code>PASSED</code> stage. You can
+      specify the keyword by changing the file ending from
+      <code>.output</code> to <code>.run_only</code>:
+<pre>
+category/test.run_only
+</pre>
+      Note that this is semantically different from specifying
+      <code>expect=diff.output</code>: The expect keyword requires that a
+      test reaches a specified stage but <i>fails</i> in it. In this case
+      the test has to reach the <code>DIFF</code> stage but fail it.
+    </p>
 
 
     <a name="layoutaddtests"></a>