From patchwork Fri Nov 28 13:45:29 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Wood X-Patchwork-Id: 5403621 Return-Path: X-Original-To: patchwork-intel-gfx@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id C175EBEEA8 for ; Fri, 28 Nov 2014 13:45:43 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 5901B20115 for ; Fri, 28 Nov 2014 13:45:42 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id B7F0C201BB for ; Fri, 28 Nov 2014 13:45:40 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 34D6A6E256; Fri, 28 Nov 2014 05:45:40 -0800 (PST) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mail-wi0-f177.google.com (mail-wi0-f177.google.com [209.85.212.177]) by gabe.freedesktop.org (Postfix) with ESMTP id 534E46E256 for ; Fri, 28 Nov 2014 05:45:39 -0800 (PST) Received: by mail-wi0-f177.google.com with SMTP id l15so11283595wiw.4 for ; Fri, 28 Nov 2014 05:45:38 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:subject:date:message-id; bh=ZeAaFOxy9zuXbSXcygxexWQsVHTN4QFGHGWGislO6To=; b=TN4b1HdiTfbAavZgwW7RUH6a2amIFjcz2ml1oEaTae7ETm0FvXFqZ99CX5+cU58zsZ C8Zapkh3PiJd21ZxOBnnvlGWOEv0Cweu8BtsHReT992Qy4RMKWqndzzAMpdeQALoGrjU LnU7rfU6LNfHH8/am6BSbVVRc0wyp+B/3AcnAMWfvoQD3SYU197LGAQTbEak8Z90lIUj t7cUiQAycL2KtUSmTBVJ4fqCapu3uZONZnfG9CpgpMyAhPIXG4UTgytes/do5O7+zIrC b4O1S18zyFDDpE6K6sXBt8686mfXz33HumxRPhf1WJI5i5y2jW2Z6WZSFz+jXyKuqOQd ejyw== X-Gm-Message-State: ALoCoQl4BuxEJan0fDIrxHvmhwfQ6psIamta3CFiHRZmIkQsQKOqYqHf/aReboLYU6Ib5bGEA/7F X-Received: by 10.180.91.36 with SMTP id cb4mr51256447wib.30.1417182338618; Fri, 28 Nov 2014 05:45:38 -0800 (PST) Received: from pistachio.icx.intel.com ([83.217.123.106]) by mx.google.com with ESMTPSA id fo12sm29621243wic.19.2014.11.28.05.45.37 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 28 Nov 2014 05:45:37 -0800 (PST) From: Thomas Wood To: intel-gfx@lists.freedesktop.org Date: Fri, 28 Nov 2014 13:45:29 +0000 Message-Id: <1417182334-20027-1-git-send-email-thomas.wood@intel.com> X-Mailer: git-send-email 2.1.0 Subject: [Intel-gfx] [PATCH i-g-t 1/6] docs: split the test program documentation into sections X-BeenThere: intel-gfx@lists.freedesktop.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Intel graphics driver community testing & development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" X-Spam-Status: No, score=-1.7 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_MED, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY, URIBL_DBL_SPAM autolearn=no version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Signed-off-by: Thomas Wood --- docs/reference/intel-gpu-tools/.gitignore | 2 +- docs/reference/intel-gpu-tools/Makefile.am | 77 +++++++++-- .../intel-gpu-tools/igt_test_programs.xml | 151 +++++++++++++++++++++ .../intel-gpu-tools/igt_test_programs.xml.header | 65 --------- .../intel-gpu-tools/intel-gpu-tools-docs.xml | 5 +- 5 files changed, 217 insertions(+), 83 deletions(-) create mode 100644 docs/reference/intel-gpu-tools/igt_test_programs.xml delete mode 100644 docs/reference/intel-gpu-tools/igt_test_programs.xml.header diff --git a/docs/reference/intel-gpu-tools/.gitignore b/docs/reference/intel-gpu-tools/.gitignore index 303929b..00c1b02 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 e02308a..cd9c771 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 0000000..2969894 --- /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 662242e..0000000 --- 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 07ced05..2115097 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