[PATCH i-g-t 3/6] docs: add exit status documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Thomas Wood <thomas.wood@xxxxxxxxx>
---
 .../intel-gpu-tools/igt_test_programs.xml          | 39 ++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/docs/reference/intel-gpu-tools/igt_test_programs.xml b/docs/reference/intel-gpu-tools/igt_test_programs.xml
index 2969894..07285fe 100644
--- a/docs/reference/intel-gpu-tools/igt_test_programs.xml
+++ b/docs/reference/intel-gpu-tools/igt_test_programs.xml
@@ -57,6 +57,45 @@
         </variablelist>
       </para>
     </refsect1>
+
+    <refsect1>
+      <title>Exit Status</title>
+      <para>
+      The following exit status codes are defined:
+
+      <informaltable pgwide="1" frame="none">
+        <tgroup cols="3" align="left">
+          <thead>
+            <row><entry>Name</entry><entry>Value</entry><entry>Description</entry></row>
+          </thead>
+          <tbody>
+            <row>
+              <entry>#IGT_EXIT_SUCCESS</entry>
+              <entry>0</entry>
+              <entry>The test was succesful</entry>
+            </row>
+            <row>
+              <entry>#IGT_EXIT_SKIP</entry>
+              <entry>77</entry>
+              <entry>The test was skipped</entry>
+            </row>
+            <row>
+              <entry>#IGT_EXIT_TIMEOUT</entry>
+              <entry>78</entry>
+              <entry>The test took longer than expected and was stopped</entry>
+            </row>
+            <row>
+              <entry>#IGT_EXIT_INVALID</entry>
+              <entry>79</entry>
+              <entry>An invalid option or subtest was specified</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+
+      Any other exit status indicates a test failure.
+    </para>
+    </refsect1>
   </refentry>
 
   <refentry id="igt-core-tests">
-- 
2.1.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@xxxxxxxxxxxxxxxxxxxxx
http://lists.freedesktop.org/mailman/listinfo/intel-gfx





[Index of Archives]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]
  Powered by Linux