From: maier <maier@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Sun, 20 Oct 2013 18:07:20 +0000 (+0000)
Subject: Add documentation
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a36842deee9faaf137cd04be42fbe79c8aa43054;p=dealii-svn.git

Add documentation

git-svn-id: https://svn.dealii.org/branches/branch_port_the_testsuite@31345 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/doc/developers/testsuite.html b/deal.II/doc/developers/testsuite.html
index 754e765dc3..31573f99e8 100644
--- a/deal.II/doc/developers/testsuite.html
+++ b/deal.II/doc/developers/testsuite.html
@@ -63,6 +63,7 @@
           <li><a href="#restrictbuild">Restricting tests for build configurations</a></li>
           <li><a href="#restrictfeature">Restricting tests for feature configurations</a></li>
           <li><a href="#mpi">Running tests with MPI</a></li>
+          <li><a href="#expect">Changing condition for success</a></li>
           <li><a href="#layoutaddtests">Adding new tests</a></li>
         </ol>
         <li><a href="#submit">Submitting test results</a></li>
@@ -433,7 +434,7 @@
       just <code>category/test.output</code>:
       <pre>
 
-    category/test.[with_&lt;feature&gt;=&lt;on|off&gt;.]*[mpirun=&lt;x&gt;.][&lt;debug|release&gt;.]output
+    category/test.[with_&lt;feature&gt;=&lt;on|off&gt;.]*[mpirun=&lt;x&gt;.][expect=&lt;y&gt;.][&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.
@@ -509,6 +510,22 @@
       files for different numbers of MPI processes.
     </p>
 
+    <a name="expect"></a>
+    <h3>Changing condition for success</h3>
+    <p>
+      Normally a test is considered to be successful if all test stages
+      could be run and the test reached the <code>PASSED</code> stage (see
+      the <a href="#runoutput">output description</a> section for details).
+      If (for some reason) the test should succeed ending at a specific
+      test stage different than <code>PASSED</code> you can specify it via
+      <code>expect=&lt;stage&gt;</code>, e.g.:
+      <pre>
+
+    category/test.expect=run.output
+      </pre>
+    </p>
+
+
 
     <a name="layoutaddtests"></a>
     <h3>Adding new tests</h3>