diff --git a/docs/reference/intel-gpu-tools/.gitignore b/docs/reference/intel-gpu-tools/.gitignore index 303929bc..00c1b023 100644 --- a/docs/reference/intel-gpu-tools/.gitignore +++ b/docs/reference/intel-gpu-tools/.gitignore @@ -3,7 +3,7 @@ /html-build.stamp /html.stamp /html/ -/igt_test_programs.xml +/igt_test_programs_*.xml /intel-gpu-tools-decl-list.txt /intel-gpu-tools-decl.txt /intel-gpu-tools-overrides.txt diff --git a/docs/reference/intel-gpu-tools/Makefile.am b/docs/reference/intel-gpu-tools/Makefile.am index e02308ae..cd9c771a 100644 --- a/docs/reference/intel-gpu-tools/Makefile.am +++ b/docs/reference/intel-gpu-tools/Makefile.am @@ -1,21 +1,47 @@ ## Process this file with automake to produce Makefile.in TESTLISTS = $(top_builddir)/tests/single-tests.txt $(top_builddir)/tests/multi-tests.txt -igt_test_programs.xml: igt_test_programs.xml.header $(TESTLISTS) - cat $(srcdir)/igt_test_programs.xml.header > $@; \ - for test in `cat $(TESTLISTS)`; do \ - if [ "$$test" = "TESTLIST" -o "$$test" = "END" ]; then \ - continue; \ - fi; \ +xml/igt_test_programs_%_programs.xml: $(TESTLISTS) + mkdir -p `dirname $@` + echo "" > $@ + echo "> $@ + echo " \"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd\"" >> $@ + echo "[" >> $@ + echo " " >> $@ + echo " " >> $@ + echo "]>" >> $@ + echo "" >> $@ + echo "Programs" >> $@ + echo "" >> $@ + for test in `cat $(TESTLISTS) | tr ' ' '\n' | grep "^$*" | sort`; do \ + echo "" >> $@; \ + echo "$$test" >> $@; \ + done; + echo "" >> $@ + echo "" >> $@ + +xml/igt_test_programs_%_description.xml: $(TESTLISTS) + mkdir -p `dirname $@` + echo "" > $@ + echo "> $@ + echo " \"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd\"" >> $@ + echo "[" >> $@ + echo " " >> $@ + echo " " >> $@ + echo "]>" >> $@ + echo "" >> $@ + echo "Description" >> $@ + for test in `cat $(TESTLISTS) | tr ' ' '\n' | grep "^$*" | sort`; do \ echo "$$test" >> $@; \ if [ -x $(top_builddir)/tests/$$test ]; then \ - ./$(top_builddir)/tests/$$test --help-description >> $@; \ + testprog=$(top_builddir)/tests/$$test; \ else \ - ./$(top_srcdir)/tests/$$test --help-description >> $@; \ + testprog=$(top_srcdir)/tests/$$test; \ fi; \ + ./$$testprog --help-description >> $@; \ echo "" >> $@; \ - done; \ - echo "" >> $@; + done; + echo "" >> $@ # We require automake 1.6 at least. AUTOMAKE_OPTIONS = 1.6 @@ -83,9 +109,32 @@ IGNORE_HFILES=gen6_render.h gen7_media.h gen7_render.h gen8_media.h \ # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png HTML_IMAGES= +test_program_files = xml/igt_test_programs_core_description.xml \ + xml/igt_test_programs_core_programs.xml \ + xml/igt_test_programs_debugfs_description.xml \ + xml/igt_test_programs_debugfs_programs.xml \ + xml/igt_test_programs_drm_description.xml \ + xml/igt_test_programs_drm_programs.xml \ + xml/igt_test_programs_drv_description.xml \ + xml/igt_test_programs_drv_programs.xml \ + xml/igt_test_programs_gem_description.xml \ + xml/igt_test_programs_gem_programs.xml \ + xml/igt_test_programs_gen3_description.xml \ + xml/igt_test_programs_gen3_programs.xml \ + xml/igt_test_programs_kms_description.xml \ + xml/igt_test_programs_kms_programs.xml \ + xml/igt_test_programs_pm_description.xml \ + xml/igt_test_programs_pm_programs.xml \ + xml/igt_test_programs_prime_description.xml \ + xml/igt_test_programs_prime_programs.xml \ + xml/igt_test_programs_sysfs_description.xml \ + xml/igt_test_programs_sysfs_programs.xml \ + $(NULL) + # 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=igt_test_programs.xml +content_files=igt_test_programs.xml $(test_program_files) \ + $(NULL) # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded # These files must be listed here *and* in content_files @@ -105,14 +154,14 @@ include $(top_srcdir)/gtk-doc.make # Other files to distribute # e.g. EXTRA_DIST += version.xml.in -EXTRA_DIST += igt_test_programs.xml.header +# EXTRA_DIST += # Files not to distribute # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt -DISTCLEANFILES = $(DOC_MODULE)-sections.txt igt_test_programs.xml +DISTCLEANFILES = $(DOC_MODULE)-sections.txt $(test_program_files) -CLEANFILES += igt_test_programs.xml +CLEANFILES += $(test_program_files) # Comment this out if you want 'make check' to test you doc status # and run some sanity checks diff --git a/docs/reference/intel-gpu-tools/igt_test_programs.xml b/docs/reference/intel-gpu-tools/igt_test_programs.xml new file mode 100644 index 00000000..29698942 --- /dev/null +++ b/docs/reference/intel-gpu-tools/igt_test_programs.xml @@ -0,0 +1,151 @@ + + + +]> + + + Test Programs + + + + Common Features + Features available in all test programs + + + Command Line Options + + All tests support the following command line options: + + + + + + list the available subtests and exit + + + + + + + run the specified subtest + + + + + + + print extra debugging information when running tests + + + + + + + print a short description of the test and exit + + + + + + + print help and exit + + + + + + + + + + Core Tests + Tests for core drm ioctls and behaviour. + + + + + + + + DRM Tests + Tests for libdrm behaviour. + + + + + + + + DRV Tests + Tests for overall driver behaviour. + + + + + + + + GEM Tests + Tests for core drm ioctls and behaviour. + + + + + + + + KMS Tests + Mode setting tests + + + + + + + + PM Tests + Tests for power management features + + + + + + + + Prime Tests + Buffer sharing tests + + + + + + + + Gen 3 Tests + Gen 3 specific tests + + + + + + + + Sysfs Tests + Sysfs tests + + + + + + + + Debugfs Tests + Debugfs tests + + + + + diff --git a/docs/reference/intel-gpu-tools/igt_test_programs.xml.header b/docs/reference/intel-gpu-tools/igt_test_programs.xml.header deleted file mode 100644 index 662242ef..00000000 --- a/docs/reference/intel-gpu-tools/igt_test_programs.xml.header +++ /dev/null @@ -1,65 +0,0 @@ - - - -]> - - -Test Programs -1 - - INTEL-GPU-TOOLS Library - - - -Tests Programs -Test cases for features and bugs - - - -Description -Test cases for bugs, features and regression testing. All tests support the -following common options: - - - - - -list the available subtests and exit - - - - - - -run the specified subtest - - - - - - -print extra debugging information when running tests - - - - - - -print a short description of the test and exit - - - - - - -print help and exit - - - - - - -Programs 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 07ced055..21150971 100644 --- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml +++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml @@ -14,7 +14,7 @@ - Intel GPU Tools + API Reference @@ -25,10 +25,9 @@ - - + API Index