[i-g-t,4/4] doc: include descriptions for the test programs

Commit Message

Thomas Wood Oct. 28, 2014, 3:03 p.m. UTC

Signed-off-by: Thomas Wood <[e-mail]>
---
 docs/reference/intel-gpu-tools/Makefile.am         | 20 ++++++-
 .../intel-gpu-tools/igt_test_programs.xml.header   | 65 ++++++++++++++++++++++
 .../intel-gpu-tools/intel-gpu-tools-docs.xml       |  1 +
 3 files changed, 84 insertions(+), 2 deletions(-)
 create mode 100644 docs/reference/intel-gpu-tools/igt_test_programs.xml.header

Patch

diff --git a/docs/reference/intel-gpu-tools/Makefile.am b/docs/reference/intel-gpu-tools/Makefile.am
index 3368e3e..bd02f5f 100644
--- a/docs/reference/intel-gpu-tools/Makefile.am
+++ b/docs/reference/intel-gpu-tools/Makefile.am
@@ -1,5 +1,21 @@ 
 ## Process this file with automake to produce Makefile.in
 
+#noinst_PROGRAMS=igt-test-scan
+#
+#AM_CFLAGS="-DTESTDIR=\"$(abs_top_srcdir)/tests\""
+
+igt_test_programs.xml:
+	cat igt_test_programs.xml.header > $@; \
+	for test in `cat $(top_builddir)/tests/single-tests.txt $(top_builddir)/tests/multi-tests.txt`; do \
+		if [ "$$test" = "TESTLIST" -o "$$test" = "END" ]; then \
+			continue; \
+		fi; \
+		echo "<refsect2 id=\"$$test\"><title>$$test</title><para>" >> $@;\
+		./$(top_srcdir)/tests/$$test --help-description >> $@; \
+		echo "</para></refsect2>" >> $@; \
+	done; \
+	echo "</refsect1></refentry>" >> $@;
+
 # We require automake 1.6 at least.
 AUTOMAKE_OPTIONS = 1.6
 
@@ -68,12 +84,12 @@  HTML_IMAGES=
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=
+content_files=igt_test_programs.xml
 
 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
 # These files must be listed here *and* in content_files
 # e.g. expand_content_files=running.sgml
-expand_content_files=
+expand_content_files=igt_test_programs.xml
 
 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
diff --git a/docs/reference/intel-gpu-tools/igt_test_programs.xml.header b/docs/reference/intel-gpu-tools/igt_test_programs.xml.header
new file mode 100644
index 0000000..662242e
--- /dev/null
+++ b/docs/reference/intel-gpu-tools/igt_test_programs.xml.header
@@ -0,0 +1,65 @@ 
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY version SYSTEM "version.xml">
+]>
+<refentry id="intel-gpu-tools-test-programs">
+<refmeta>
+<refentrytitle role="top_of_page" id="intel-gpu-tools-test-programs.top_of_page">Test Programs</refentrytitle>
+<manvolnum>1</manvolnum>
+<refmiscinfo>
+  INTEL-GPU-TOOLS Library
+</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>Tests Programs</refname>
+<refpurpose>Test cases for features and bugs</refpurpose>
+</refnamediv>
+
+<refsect1 id="intel-gpu-tools-test-programs.description" role="desc">
+<title role="desc.title">Description</title>
+Test cases for bugs, features and regression testing. All tests support the
+following common options:
+
+<variablelist>
+<varlistentry>
+<term><option>--list-subtests</option></term>
+<listitem><para>
+list the available subtests and exit
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--run-subtest <replaceable>subtest</replaceable></option></term>
+<listitem><para>
+run the specified subtest
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--debug</option></term>
+<listitem><para>
+print extra debugging information when running tests
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--help-description</option></term>
+<listitem><para>
+print a short description of the test and exit
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term><option>--help</option></term>
+<listitem><para>
+print help and exit
+</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect1>
+
+<refsect1>
+<title>Programs</title>
diff --git a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
index 3d9caf8..07ced05 100644
--- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
+++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
@@ -25,6 +25,7 @@ 
     <xi:include href="xml/intel_batchbuffer.xml"/>
     <xi:include href="xml/intel_chipset.xml"/>
     <xi:include href="xml/intel_io.xml"/>
+    <xi:include href="xml/igt_test_programs.xml"/>
     <xi:include href="xml/igt_edid.xml"/>
 
   </chapter>