From eccae1360d6d01e73c6af2bd97122cef708207ef Mon Sep 17 00:00:00 2001 From: Arkadiusz Hiler Date: Tue, 15 May 2018 14:07:50 +0300 Subject: igt: Drop Intel from the name in docs and paths This is just a simple change to reflect the actual state. No rewording yet, just a simple substitution in most visible places - docs, README and paths. There are probably some leftovers here and there, but we can let them be for now, this is already well overdue. v2: fixed couple of obvious leftovers pointed out by Petri Cc: Petri Latvala Cc: Daniel Vetter Signed-off-by: Arkadiusz Hiler Acked-by: Harry Wentland Reviewed-by: Petri Latvala --- docs/reference/Makefile.am | 2 +- docs/reference/igt-gpu-tools/.gitignore | 27 ++ docs/reference/igt-gpu-tools/Makefile.am | 218 ++++++++++++ .../igt-gpu-tools/generate_description_xml.sh | 46 +++ .../igt-gpu-tools/generate_programs_xml.sh | 22 ++ .../reference/igt-gpu-tools/igt-gpu-tools-docs.xml | 67 ++++ docs/reference/igt-gpu-tools/igt_test_programs.xml | 386 +++++++++++++++++++++ docs/reference/igt-gpu-tools/meson.build | 80 +++++ docs/reference/igt-gpu-tools/version.xml.in | 1 + docs/reference/intel-gpu-tools/.gitignore | 27 -- docs/reference/intel-gpu-tools/Makefile.am | 218 ------------ .../intel-gpu-tools/generate_description_xml.sh | 46 --- .../intel-gpu-tools/generate_programs_xml.sh | 22 -- .../intel-gpu-tools/igt_test_programs.xml | 386 --------------------- .../intel-gpu-tools/intel-gpu-tools-docs.xml | 67 ---- docs/reference/intel-gpu-tools/meson.build | 80 ----- docs/reference/intel-gpu-tools/version.xml.in | 1 - docs/reference/meson.build | 2 +- 18 files changed, 849 insertions(+), 849 deletions(-) create mode 100644 docs/reference/igt-gpu-tools/.gitignore create mode 100644 docs/reference/igt-gpu-tools/Makefile.am create mode 100644 docs/reference/igt-gpu-tools/generate_description_xml.sh create mode 100755 docs/reference/igt-gpu-tools/generate_programs_xml.sh create mode 100644 docs/reference/igt-gpu-tools/igt-gpu-tools-docs.xml create mode 100644 docs/reference/igt-gpu-tools/igt_test_programs.xml create mode 100644 docs/reference/igt-gpu-tools/meson.build create mode 100644 docs/reference/igt-gpu-tools/version.xml.in delete mode 100644 docs/reference/intel-gpu-tools/.gitignore delete mode 100644 docs/reference/intel-gpu-tools/Makefile.am delete mode 100644 docs/reference/intel-gpu-tools/generate_description_xml.sh delete mode 100755 docs/reference/intel-gpu-tools/generate_programs_xml.sh delete mode 100644 docs/reference/intel-gpu-tools/igt_test_programs.xml delete mode 100644 docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml delete mode 100644 docs/reference/intel-gpu-tools/meson.build delete mode 100644 docs/reference/intel-gpu-tools/version.xml.in (limited to 'docs') diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 4f579b58..13a1954e 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -1 +1 @@ -SUBDIRS = intel-gpu-tools +SUBDIRS = igt-gpu-tools diff --git a/docs/reference/igt-gpu-tools/.gitignore b/docs/reference/igt-gpu-tools/.gitignore new file mode 100644 index 00000000..9a788a26 --- /dev/null +++ b/docs/reference/igt-gpu-tools/.gitignore @@ -0,0 +1,27 @@ +/gtkdoc-check.log +/gtkdoc-check.trs +/html-build.stamp +/html.stamp +/html/ +/igt_test_programs_*.xml +/igt-gpu-tools-decl-list.txt +/igt-gpu-tools-decl.txt +/igt-gpu-tools-overrides.txt +/igt-gpu-tools-sections.txt +/igt-gpu-tools-undeclared.txt +/igt-gpu-tools-undocumented.txt +/igt-gpu-tools-unused.txt +/igt-gpu-tools.args +/igt-gpu-tools.hierarchy +/igt-gpu-tools.igt +/igt-gpu-tools.prerequisites +/igt-gpu-tools.signals +/igt-gpu-tools.types +/scan-build.stamp +/setup-build.stamp +/sgml-build.stamp +/sgml.stamp +/test-suite.log +/version.xml +/xml/ + diff --git a/docs/reference/igt-gpu-tools/Makefile.am b/docs/reference/igt-gpu-tools/Makefile.am new file mode 100644 index 00000000..11ada326 --- /dev/null +++ b/docs/reference/igt-gpu-tools/Makefile.am @@ -0,0 +1,218 @@ +## Process this file with automake to produce Makefile.in + +TESTLISTS = $(top_builddir)/tests/test-list.txt +KEYWORDS = (invalid|hang|swap|thrash|crc|tiled|tiling|rte|ctx|render|blt|bsd|vebox|exec|rpm) + +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 "" >> $@; \ + echo "$$test" | perl -pe 's/(?<=_)$(KEYWORDS)(?=(_|\W))/<acronym>\1<\/acronym>/g' >> $@; \ + echo "> $@; \ + if [ -x $(top_builddir)/tests/$$test ]; then \ + testprog=$(top_builddir)/tests/$$test; \ + else \ + testprog=$(top_srcdir)/tests/$$test; \ + fi; \ + ./$$testprog --help-description >> $@; \ + echo "]]>" >> $@; \ + if ./$$testprog --list-subtests > /dev/null ; then \ + echo "Subtests" >> $@; \ + subtest_list=`./$$testprog --list-subtests`; \ + subtest_count=`echo $$subtest_list | wc -w`; \ + if [ $$subtest_count -gt 100 ]; then \ + echo "This test has over 100 subtests. " >> $@; \ + echo "Run $$test to list them." >> $@; \ + else \ + echo "" >> $@; \ + for subtest in $$subtest_list; do \ + echo "" >> $@; \ + echo "$$subtest" | perl -pe 's/\b$(KEYWORDS)\b/\1<\/acronym>/g' >> $@; \ + echo "" >> $@; \ + done; \ + echo "" >> $@; \ + fi; \ + echo "" >> $@; \ + fi; \ + echo "" >> $@; \ + done; + echo "" >> $@ + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=igt-gpu-tools + +# Uncomment for versioned docs and specify the version of the module, e.g. '2'. +#DOC_MODULE_VERSION=2 + + +# The top-level XML file (SGML in the past). You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml + +# Directories containing the source code. +# gtk-doc will search all .c and .h files beneath these paths +# for inline comments documenting functions and macros. +# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk +DOC_SOURCE_DIR=$(top_srcdir)/lib + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS=--rebuild-sections + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml +MKDB_OPTIONS=--output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-mkhtml +MKHTML_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/lib/*.h +CFILE_GLOB=$(top_srcdir)/lib/*.c + +# Extra header to include when scanning, which are not under DOC_SOURCE_DIR +# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h +EXTRA_HFILES= + +# Header files or dirs to ignore when scanning. Use base file/dir names +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code +IGNORE_HFILES=gen6_render.h gen7_media.h gen7_render.h gen8_media.h \ + gen8_render.h gpgpu_fill.h i830_reg.h i915_3d.h i915_pciids.h \ + i915_reg.h igt_edid_template.h intel_reg.h debug.h instdone.h \ + media_fill.h rendercopy.h media_spin.h media_fill_gen9.h \ + gen9_render.h version.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +test_program_files = xml/igt_test_programs_amdgpu_description.xml \ + xml/igt_test_programs_amdgpu_programs.xml \ + xml/igt_test_programs_chamelium_description.xml \ + xml/igt_test_programs_chamelium_programs.xml \ + 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_gen7_description.xml \ + xml/igt_test_programs_gen7_programs.xml \ + xml/igt_test_programs_gvt_description.xml \ + xml/igt_test_programs_gvt_programs.xml \ + xml/igt_test_programs_kms_description.xml \ + xml/igt_test_programs_kms_programs.xml \ + xml/igt_test_programs_meta_description.xml \ + xml/igt_test_programs_meta_programs.xml \ + xml/igt_test_programs_perf_description.xml \ + xml/igt_test_programs_perf_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_sw_sync_description.xml \ + xml/igt_test_programs_sw_sync_programs.xml \ + xml/igt_test_programs_testdisplay_description.xml \ + xml/igt_test_programs_testdisplay_programs.xml \ + xml/igt_test_programs_tools_description.xml \ + xml/igt_test_programs_tools_programs.xml \ + xml/igt_test_programs_vgem_description.xml \ + xml/igt_test_programs_vgem_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 $(test_program_files) \ + $(NULL) + +# 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=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 +# signals and properties. +# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS= +GTKDOC_LIBS= + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +# 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 $(test_program_files) + +CLEANFILES += $(test_program_files) + +# Comment this out if you want 'make check' to test you doc status +# and run some sanity checks +if ENABLE_GTK_DOC +TESTS_ENVIRONMENT = cd $(srcdir) && \ + DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ + SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) +#TESTS = $(GTKDOC_CHECK) +endif + +-include $(top_srcdir)/git.mk diff --git a/docs/reference/igt-gpu-tools/generate_description_xml.sh b/docs/reference/igt-gpu-tools/generate_description_xml.sh new file mode 100644 index 00000000..705a7bf3 --- /dev/null +++ b/docs/reference/igt-gpu-tools/generate_description_xml.sh @@ -0,0 +1,46 @@ +#!/bin/sh + +output=$1 +filter=$2 +testlist=$3 +testdir=$(dirname $testlist) + +KEYWORDS="(invalid|hang|swap|thrash|crc|tiled|tiling|rte|ctx|render|blt|bsd|vebox|exec|rpm)" + +echo "" > $output +echo "> $output +echo " \"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd\"" >> $output +echo "[" >> $output +echo " " >> $output +echo " " >> $output +echo "]>" >> $output +echo "" >> $output +echo "Description" >> $output +for test in `cat $testlist | tr ' ' '\n' | grep "^$filter" | sort`; do + echo "" >> $output; + echo "$test" | perl -pe "s/(?<=_)$KEYWORDS(?=(_|\\W))/<acronym>\\1<\\/acronym>/g" >> $output; + echo "> $output; + testprog=$testdir/$test; + ./$testprog --help-description >> $output; + echo "]]>" >> $output; + if ./$testprog --list-subtests > /dev/null ; then + echo "Subtests" >> $output; + subtest_list=`./$testprog --list-subtests`; + subtest_count=`echo $subtest_list | wc -w`; + if [ $subtest_count -gt 100 ]; then + echo "This test has over 100 subtests. " >> $output; + echo "Run $test to list them." >> $output; + else + echo "" >> $output; + for subtest in $subtest_list; do + echo "" >> $output; + echo "$subtest" | perl -pe "s/\\b$KEYWORDS\\b/\\1<\\/acronym>/g" >> $output; + echo "" >> $output; + done; + echo "" >> $output; + fi; + echo "" >> $output; + fi; + echo "" >> $output; +done; +echo "" >> $output diff --git a/docs/reference/igt-gpu-tools/generate_programs_xml.sh b/docs/reference/igt-gpu-tools/generate_programs_xml.sh new file mode 100755 index 00000000..73adc8cc --- /dev/null +++ b/docs/reference/igt-gpu-tools/generate_programs_xml.sh @@ -0,0 +1,22 @@ +#!/bin/sh + +output=$1 +filter=$2 +testlist=$3 + +echo "" > $output +echo "> $output +echo " \"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd\"" >> $output +echo "[" >> $output +echo " " >> $output +echo " " >> $output +echo "]>" >> $output +echo "" >> $output +echo "Programs" >> $output +echo "" >> $output +for test in `cat $testlist | tr ' ' '\n' | grep "^$filter" | sort`; do + echo "" >> $output; + echo "$test" >> $output; +done; +echo "" >> $output +echo "" >> $output diff --git a/docs/reference/igt-gpu-tools/igt-gpu-tools-docs.xml b/docs/reference/igt-gpu-tools/igt-gpu-tools-docs.xml new file mode 100644 index 00000000..ac83272f --- /dev/null +++ b/docs/reference/igt-gpu-tools/igt-gpu-tools-docs.xml @@ -0,0 +1,67 @@ + + + +]> + + + igt-gpu-tools Reference Manual + + for igt-gpu-tools &version;. + + + + + API Reference + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + igt/i915 API Reference + + + + + + + + + API Index + + + + Index of deprecated API + + + diff --git a/docs/reference/igt-gpu-tools/igt_test_programs.xml b/docs/reference/igt-gpu-tools/igt_test_programs.xml new file mode 100644 index 00000000..ec05d53e --- /dev/null +++ b/docs/reference/igt-gpu-tools/igt_test_programs.xml @@ -0,0 +1,386 @@ + + + +]> + + + 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 and + optionally only show the messages from the specified log domain + (use "application" to specify the default application domain) + + + + + + + print a short description of the test and exit + + + + + + + print help and exit + + + + + + + + Exit Status + + The following exit status codes are defined: + + + + + NameValueDescription + + + + #IGT_EXIT_SUCCESS + 0 + The test was successful + + + #IGT_EXIT_SKIP + 77 + The test was skipped + + + #IGT_EXIT_TIMEOUT + 78 + The test took longer than expected and was stopped + + + #IGT_EXIT_INVALID + 79 + An invalid option or subtest was specified + + + + + + Any other exit status indicates a test failure. + + + + + + + AMDGPU Tests + Tests for amdgpu driver behaviour + + + + + + + + Chamelium Tests + Tests using the Chamelium platform + + + + + + + + Core Tests + Tests for core drm ioctls and behaviour + + + + + + + + Debugfs Tests + Tests for debugfs behaviour + + + + + + + + DRM Tests + Tests for libdrm behaviour + + + + + + + + DRV Tests + Tests for overall driver behaviour + + + + + + + + GEM Tests + Tests for the graphics execution manager + + + + + + + + Gen 3 Tests + Tests specific to gen 3 + + + + + + + + Gen 7 Tests + Tests specific to gen 7 + + + + + + + + GVT Tests + Tests for graphics virtualization technology + + + + + + + + KMS Tests + Tests for kernel mode setting + + + + + + + + Meta Tests + Tests for the CI system itself + + + + + + + + Perf Tests + Tests for the performance metrics + + + + + + + + PM Tests + Tests for power management features + + + + + + + + Prime Tests + Tests for buffer sharding + + + + + + + + SW Sync Tests + Tests for software sync (fencing) + + + + + + + + Display Tests + Tests for display validation + + + + + + + + Tools Tests + Tests for IGT tools behaviour + + + + + + + + vGEM Tests + Tests for the vitual graphics execution manager + + + + + + + Glossary + + The following terms are commonly used in test names to describe + various features of the test and can be used to filter and select + particular tests. + + + invalid + + Negative tests to validate kernel interface input validation. + + + + + hang + + Tests that provoke gpu hangs. + + + + + swap + + Tests that force their full working sets through swap. + + + + + thrash + + Tests that tend to have really slow forward progress due to gtt/memory/.. thrashing. + + + + + crc + + Tests that use the display CRC infrastructure to check the results. + + + + + tiled + + Tests that exercise behaviour on tiled buffers. + + + + + tiling + + Tests that exercise behaviour on tiled buffers. + + + + + rte + + Runtime environment checks. + + + + + ctx + + Tests that exercise the hardware context support. + + + + + render + + Tests which apply to the render ring. + + + + + blt + + Tests which apply to the blt ring. + + + + + bsd + + Tests which apply to the bsd ring. + + + + + vebox + + Tests which apply to the vebox ring. + + + + + exec + + Tests that exercise the execbuf code in various ways. + + + + + rpm + + Runtime power management tests. + + + + diff --git a/docs/reference/igt-gpu-tools/meson.build b/docs/reference/igt-gpu-tools/meson.build new file mode 100644 index 00000000..aadb9af5 --- /dev/null +++ b/docs/reference/igt-gpu-tools/meson.build @@ -0,0 +1,80 @@ +gnome = import('gnome') + +ignore_headers = [ + 'gen6_render.h', + 'gen7_media.h', + 'gen7_render.h', + 'gen8_media.h', + 'gen8_render.h', + 'gpgpu_fill.h', + 'i830_reg.h', + 'i915_3d.h', + 'i915_pciids.h', + 'i915_reg.h', + 'igt_edid_template.h', + 'intel_reg.h', + 'debug.h', + 'instdone.h', + 'media_fill.h', + 'rendercopy.h', + 'media_spin.h', + 'media_fill_gen9.h', + 'gen9_render.h', + 'version.h', +] + +test_groups = [ + 'amdgpu', + 'chamelium', + 'core', + 'debugfs', + 'drm', + 'drv', + 'gem', + 'gen3', + 'gen7', + 'gvt', + 'kms', + 'meta', + 'perf', + 'pm', + 'prime', + 'sw_sync', + 'testdisplay', + 'tools', + 'vgem', +] + +gen_description = find_program('generate_description_xml.sh') +gen_programs = find_program('generate_programs_xml.sh') + +test_list_files = [] + +foreach group : test_groups + programs_xml = 'igt_test_programs_' + group + '_programs.xml' + custom_target(programs_xml, + output : programs_xml, + build_by_default : true, + command : [ gen_programs, '@OUTPUT@', group, test_list ]) + + description_xml = 'igt_test_programs_' + group + '_description.xml' + custom_target(description_xml, + output : description_xml, + build_by_default : true, + depends : test_executables, + command : [ gen_description, '@OUTPUT@', group, test_list ]) +endforeach + +configure_file(input: 'version.xml.in', + output: 'version.xml', + install: false, configuration: config) + +gnome.gtkdoc('igt-gpu-tools', + content_files : ['igt_test_programs.xml'], + dependencies : lib_igt, + install : true, + main_xml : 'igt-gpu-tools-docs.xml', + scan_args : '--rebuild-sections', + mkdb_args : '--output-format=xml', + ignore_headers : ignore_headers, + src_dir : inc_for_gtkdoc) diff --git a/docs/reference/igt-gpu-tools/version.xml.in b/docs/reference/igt-gpu-tools/version.xml.in new file mode 100644 index 00000000..a24f9877 --- /dev/null +++ b/docs/reference/igt-gpu-tools/version.xml.in @@ -0,0 +1 @@ +@PACKAGE_VERSION@ diff --git a/docs/reference/intel-gpu-tools/.gitignore b/docs/reference/intel-gpu-tools/.gitignore deleted file mode 100644 index 00c1b023..00000000 --- a/docs/reference/intel-gpu-tools/.gitignore +++ /dev/null @@ -1,27 +0,0 @@ -/gtkdoc-check.log -/gtkdoc-check.trs -/html-build.stamp -/html.stamp -/html/ -/igt_test_programs_*.xml -/intel-gpu-tools-decl-list.txt -/intel-gpu-tools-decl.txt -/intel-gpu-tools-overrides.txt -/intel-gpu-tools-sections.txt -/intel-gpu-tools-undeclared.txt -/intel-gpu-tools-undocumented.txt -/intel-gpu-tools-unused.txt -/intel-gpu-tools.args -/intel-gpu-tools.hierarchy -/intel-gpu-tools.interfaces -/intel-gpu-tools.prerequisites -/intel-gpu-tools.signals -/intel-gpu-tools.types -/scan-build.stamp -/setup-build.stamp -/sgml-build.stamp -/sgml.stamp -/test-suite.log -/version.xml -/xml/ - diff --git a/docs/reference/intel-gpu-tools/Makefile.am b/docs/reference/intel-gpu-tools/Makefile.am deleted file mode 100644 index ee1e900f..00000000 --- a/docs/reference/intel-gpu-tools/Makefile.am +++ /dev/null @@ -1,218 +0,0 @@ -## Process this file with automake to produce Makefile.in - -TESTLISTS = $(top_builddir)/tests/test-list.txt -KEYWORDS = (invalid|hang|swap|thrash|crc|tiled|tiling|rte|ctx|render|blt|bsd|vebox|exec|rpm) - -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 "" >> $@; \ - echo "$$test" | perl -pe 's/(?<=_)$(KEYWORDS)(?=(_|\W))/<acronym>\1<\/acronym>/g' >> $@; \ - echo "> $@; \ - if [ -x $(top_builddir)/tests/$$test ]; then \ - testprog=$(top_builddir)/tests/$$test; \ - else \ - testprog=$(top_srcdir)/tests/$$test; \ - fi; \ - ./$$testprog --help-description >> $@; \ - echo "]]>" >> $@; \ - if ./$$testprog --list-subtests > /dev/null ; then \ - echo "Subtests" >> $@; \ - subtest_list=`./$$testprog --list-subtests`; \ - subtest_count=`echo $$subtest_list | wc -w`; \ - if [ $$subtest_count -gt 100 ]; then \ - echo "This test has over 100 subtests. " >> $@; \ - echo "Run $$test to list them." >> $@; \ - else \ - echo "" >> $@; \ - for subtest in $$subtest_list; do \ - echo "" >> $@; \ - echo "$$subtest" | perl -pe 's/\b$(KEYWORDS)\b/\1<\/acronym>/g' >> $@; \ - echo "" >> $@; \ - done; \ - echo "" >> $@; \ - fi; \ - echo "" >> $@; \ - fi; \ - echo "" >> $@; \ - done; - echo "" >> $@ - -# We require automake 1.6 at least. -AUTOMAKE_OPTIONS = 1.6 - -# This is a blank Makefile.am for using gtk-doc. -# Copy this to your project's API docs directory and modify the variables to -# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples -# of using the various options. - -# The name of the module, e.g. 'glib'. -DOC_MODULE=intel-gpu-tools - -# Uncomment for versioned docs and specify the version of the module, e.g. '2'. -#DOC_MODULE_VERSION=2 - - -# The top-level XML file (SGML in the past). You can change this if you want to. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml - -# Directories containing the source code. -# gtk-doc will search all .c and .h files beneath these paths -# for inline comments documenting functions and macros. -# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk -DOC_SOURCE_DIR=$(top_srcdir)/lib - -# Extra options to pass to gtkdoc-scangobj. Not normally needed. -SCANGOBJ_OPTIONS= - -# Extra options to supply to gtkdoc-scan. -# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" -SCAN_OPTIONS=--rebuild-sections - -# Extra options to supply to gtkdoc-mkdb. -# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml -MKDB_OPTIONS=--output-format=xml - -# Extra options to supply to gtkdoc-mktmpl -# e.g. MKTMPL_OPTIONS=--only-section-tmpl -MKTMPL_OPTIONS= - -# Extra options to supply to gtkdoc-mkhtml -MKHTML_OPTIONS= - -# Extra options to supply to gtkdoc-fixref. Not normally needed. -# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html -FIXXREF_OPTIONS= - -# Used for dependencies. The docs will be rebuilt if any of these change. -# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h -# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c -HFILE_GLOB=$(top_srcdir)/lib/*.h -CFILE_GLOB=$(top_srcdir)/lib/*.c - -# Extra header to include when scanning, which are not under DOC_SOURCE_DIR -# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h -EXTRA_HFILES= - -# Header files or dirs to ignore when scanning. Use base file/dir names -# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code -IGNORE_HFILES=gen6_render.h gen7_media.h gen7_render.h gen8_media.h \ - gen8_render.h gpgpu_fill.h i830_reg.h i915_3d.h i915_pciids.h \ - i915_reg.h igt_edid_template.h intel_reg.h debug.h instdone.h \ - media_fill.h rendercopy.h media_spin.h media_fill_gen9.h \ - gen9_render.h version.h - -# Images to copy into HTML directory. -# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png -HTML_IMAGES= - -test_program_files = xml/igt_test_programs_amdgpu_description.xml \ - xml/igt_test_programs_amdgpu_programs.xml \ - xml/igt_test_programs_chamelium_description.xml \ - xml/igt_test_programs_chamelium_programs.xml \ - 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_gen7_description.xml \ - xml/igt_test_programs_gen7_programs.xml \ - xml/igt_test_programs_gvt_description.xml \ - xml/igt_test_programs_gvt_programs.xml \ - xml/igt_test_programs_kms_description.xml \ - xml/igt_test_programs_kms_programs.xml \ - xml/igt_test_programs_meta_description.xml \ - xml/igt_test_programs_meta_programs.xml \ - xml/igt_test_programs_perf_description.xml \ - xml/igt_test_programs_perf_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_sw_sync_description.xml \ - xml/igt_test_programs_sw_sync_programs.xml \ - xml/igt_test_programs_testdisplay_description.xml \ - xml/igt_test_programs_testdisplay_programs.xml \ - xml/igt_test_programs_tools_description.xml \ - xml/igt_test_programs_tools_programs.xml \ - xml/igt_test_programs_vgem_description.xml \ - xml/igt_test_programs_vgem_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 $(test_program_files) \ - $(NULL) - -# 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=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 -# signals and properties. -# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) -# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) -GTKDOC_CFLAGS= -GTKDOC_LIBS= - -# This includes the standard gtk-doc make rules, copied by gtkdocize. -include $(top_srcdir)/gtk-doc.make - -# Other files to distribute -# e.g. EXTRA_DIST += version.xml.in -# 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 $(test_program_files) - -CLEANFILES += $(test_program_files) - -# Comment this out if you want 'make check' to test you doc status -# and run some sanity checks -if ENABLE_GTK_DOC -TESTS_ENVIRONMENT = cd $(srcdir) && \ - DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ - SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) -#TESTS = $(GTKDOC_CHECK) -endif - --include $(top_srcdir)/git.mk diff --git a/docs/reference/intel-gpu-tools/generate_description_xml.sh b/docs/reference/intel-gpu-tools/generate_description_xml.sh deleted file mode 100644 index 705a7bf3..00000000 --- a/docs/reference/intel-gpu-tools/generate_description_xml.sh +++ /dev/null @@ -1,46 +0,0 @@ -#!/bin/sh - -output=$1 -filter=$2 -testlist=$3 -testdir=$(dirname $testlist) - -KEYWORDS="(invalid|hang|swap|thrash|crc|tiled|tiling|rte|ctx|render|blt|bsd|vebox|exec|rpm)" - -echo "" > $output -echo "> $output -echo " \"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd\"" >> $output -echo "[" >> $output -echo " " >> $output -echo " " >> $output -echo "]>" >> $output -echo "" >> $output -echo "Description" >> $output -for test in `cat $testlist | tr ' ' '\n' | grep "^$filter" | sort`; do - echo "" >> $output; - echo "$test" | perl -pe "s/(?<=_)$KEYWORDS(?=(_|\\W))/<acronym>\\1<\\/acronym>/g" >> $output; - echo "> $output; - testprog=$testdir/$test; - ./$testprog --help-description >> $output; - echo "]]>" >> $output; - if ./$testprog --list-subtests > /dev/null ; then - echo "Subtests" >> $output; - subtest_list=`./$testprog --list-subtests`; - subtest_count=`echo $subtest_list | wc -w`; - if [ $subtest_count -gt 100 ]; then - echo "This test has over 100 subtests. " >> $output; - echo "Run $test to list them." >> $output; - else - echo "" >> $output; - for subtest in $subtest_list; do - echo "" >> $output; - echo "$subtest" | perl -pe "s/\\b$KEYWORDS\\b/\\1<\\/acronym>/g" >> $output; - echo "" >> $output; - done; - echo "" >> $output; - fi; - echo "" >> $output; - fi; - echo "" >> $output; -done; -echo "" >> $output diff --git a/docs/reference/intel-gpu-tools/generate_programs_xml.sh b/docs/reference/intel-gpu-tools/generate_programs_xml.sh deleted file mode 100755 index 73adc8cc..00000000 --- a/docs/reference/intel-gpu-tools/generate_programs_xml.sh +++ /dev/null @@ -1,22 +0,0 @@ -#!/bin/sh - -output=$1 -filter=$2 -testlist=$3 - -echo "" > $output -echo "> $output -echo " \"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd\"" >> $output -echo "[" >> $output -echo " " >> $output -echo " " >> $output -echo "]>" >> $output -echo "" >> $output -echo "Programs" >> $output -echo "" >> $output -for test in `cat $testlist | tr ' ' '\n' | grep "^$filter" | sort`; do - echo "" >> $output; - echo "$test" >> $output; -done; -echo "" >> $output -echo "" >> $output diff --git a/docs/reference/intel-gpu-tools/igt_test_programs.xml b/docs/reference/intel-gpu-tools/igt_test_programs.xml deleted file mode 100644 index ec05d53e..00000000 --- a/docs/reference/intel-gpu-tools/igt_test_programs.xml +++ /dev/null @@ -1,386 +0,0 @@ - - - -]> - - - 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 and - optionally only show the messages from the specified log domain - (use "application" to specify the default application domain) - - - - - - - print a short description of the test and exit - - - - - - - print help and exit - - - - - - - - Exit Status - - The following exit status codes are defined: - - - - - NameValueDescription - - - - #IGT_EXIT_SUCCESS - 0 - The test was successful - - - #IGT_EXIT_SKIP - 77 - The test was skipped - - - #IGT_EXIT_TIMEOUT - 78 - The test took longer than expected and was stopped - - - #IGT_EXIT_INVALID - 79 - An invalid option or subtest was specified - - - - - - Any other exit status indicates a test failure. - - - - - - - AMDGPU Tests - Tests for amdgpu driver behaviour - - - - - - - - Chamelium Tests - Tests using the Chamelium platform - - - - - - - - Core Tests - Tests for core drm ioctls and behaviour - - - - - - - - Debugfs Tests - Tests for debugfs behaviour - - - - - - - - DRM Tests - Tests for libdrm behaviour - - - - - - - - DRV Tests - Tests for overall driver behaviour - - - - - - - - GEM Tests - Tests for the graphics execution manager - - - - - - - - Gen 3 Tests - Tests specific to gen 3 - - - - - - - - Gen 7 Tests - Tests specific to gen 7 - - - - - - - - GVT Tests - Tests for graphics virtualization technology - - - - - - - - KMS Tests - Tests for kernel mode setting - - - - - - - - Meta Tests - Tests for the CI system itself - - - - - - - - Perf Tests - Tests for the performance metrics - - - - - - - - PM Tests - Tests for power management features - - - - - - - - Prime Tests - Tests for buffer sharding - - - - - - - - SW Sync Tests - Tests for software sync (fencing) - - - - - - - - Display Tests - Tests for display validation - - - - - - - - Tools Tests - Tests for IGT tools behaviour - - - - - - - - vGEM Tests - Tests for the vitual graphics execution manager - - - - - - - Glossary - - The following terms are commonly used in test names to describe - various features of the test and can be used to filter and select - particular tests. - - - invalid - - Negative tests to validate kernel interface input validation. - - - - - hang - - Tests that provoke gpu hangs. - - - - - swap - - Tests that force their full working sets through swap. - - - - - thrash - - Tests that tend to have really slow forward progress due to gtt/memory/.. thrashing. - - - - - crc - - Tests that use the display CRC infrastructure to check the results. - - - - - tiled - - Tests that exercise behaviour on tiled buffers. - - - - - tiling - - Tests that exercise behaviour on tiled buffers. - - - - - rte - - Runtime environment checks. - - - - - ctx - - Tests that exercise the hardware context support. - - - - - render - - Tests which apply to the render ring. - - - - - blt - - Tests which apply to the blt ring. - - - - - bsd - - Tests which apply to the bsd ring. - - - - - vebox - - Tests which apply to the vebox ring. - - - - - exec - - Tests that exercise the execbuf code in various ways. - - - - - rpm - - Runtime power management tests. - - - - diff --git a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml deleted file mode 100644 index 7d9efd77..00000000 --- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - -]> - - - intel-gpu-tools Reference Manual - - for intel-gpu-tools &version;. - - - - - API Reference - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - igt/i915 API Reference - - - - - - - - - API Index - - - - Index of deprecated API - - - diff --git a/docs/reference/intel-gpu-tools/meson.build b/docs/reference/intel-gpu-tools/meson.build deleted file mode 100644 index 1c009229..00000000 --- a/docs/reference/intel-gpu-tools/meson.build +++ /dev/null @@ -1,80 +0,0 @@ -gnome = import('gnome') - -ignore_headers = [ - 'gen6_render.h', - 'gen7_media.h', - 'gen7_render.h', - 'gen8_media.h', - 'gen8_render.h', - 'gpgpu_fill.h', - 'i830_reg.h', - 'i915_3d.h', - 'i915_pciids.h', - 'i915_reg.h', - 'igt_edid_template.h', - 'intel_reg.h', - 'debug.h', - 'instdone.h', - 'media_fill.h', - 'rendercopy.h', - 'media_spin.h', - 'media_fill_gen9.h', - 'gen9_render.h', - 'version.h', -] - -test_groups = [ - 'amdgpu', - 'chamelium', - 'core', - 'debugfs', - 'drm', - 'drv', - 'gem', - 'gen3', - 'gen7', - 'gvt', - 'kms', - 'meta', - 'perf', - 'pm', - 'prime', - 'sw_sync', - 'testdisplay', - 'tools', - 'vgem', -] - -gen_description = find_program('generate_description_xml.sh') -gen_programs = find_program('generate_programs_xml.sh') - -test_list_files = [] - -foreach group : test_groups - programs_xml = 'igt_test_programs_' + group + '_programs.xml' - custom_target(programs_xml, - output : programs_xml, - build_by_default : true, - command : [ gen_programs, '@OUTPUT@', group, test_list ]) - - description_xml = 'igt_test_programs_' + group + '_description.xml' - custom_target(description_xml, - output : description_xml, - build_by_default : true, - depends : test_executables, - command : [ gen_description, '@OUTPUT@', group, test_list ]) -endforeach - -configure_file(input: 'version.xml.in', - output: 'version.xml', - install: false, configuration: config) - -gnome.gtkdoc('intel-gpu-tools', - content_files : ['igt_test_programs.xml'], - dependencies : lib_igt, - install : true, - main_xml : 'intel-gpu-tools-docs.xml', - scan_args : '--rebuild-sections', - mkdb_args : '--output-format=xml', - ignore_headers : ignore_headers, - src_dir : inc_for_gtkdoc) diff --git a/docs/reference/intel-gpu-tools/version.xml.in b/docs/reference/intel-gpu-tools/version.xml.in deleted file mode 100644 index a24f9877..00000000 --- a/docs/reference/intel-gpu-tools/version.xml.in +++ /dev/null @@ -1 +0,0 @@ -@PACKAGE_VERSION@ diff --git a/docs/reference/meson.build b/docs/reference/meson.build index 944f28a5..85a8aa47 100644 --- a/docs/reference/meson.build +++ b/docs/reference/meson.build @@ -1 +1 @@ -subdir('intel-gpu-tools') +subdir('igt-gpu-tools') -- cgit v1.2.3