From patchwork Thu Jul 20 14:11:52 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Kocialkowki X-Patchwork-Id: 9855043 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 84BCB600F5 for ; Thu, 20 Jul 2017 14:12:01 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 748FA285B0 for ; Thu, 20 Jul 2017 14:12:01 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 65349286F2; Thu, 20 Jul 2017 14:12:01 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=2.0 tests=BAYES_00, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 5EFC4285B0 for ; Thu, 20 Jul 2017 14:12:00 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 1D65C6E143; Thu, 20 Jul 2017 14:11:59 +0000 (UTC) X-Original-To: intel-gfx@lists.freedesktop.org Delivered-To: intel-gfx@lists.freedesktop.org Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by gabe.freedesktop.org (Postfix) with ESMTPS id 619B16E143 for ; Thu, 20 Jul 2017 14:11:58 +0000 (UTC) Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 20 Jul 2017 07:11:57 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.40,384,1496127600"; d="scan'208";a="129037789" Received: from linux.intel.com ([10.54.29.200]) by fmsmga005.fm.intel.com with ESMTP; 20 Jul 2017 07:11:56 -0700 Received: from workstation.fi.intel.com (workstation.fi.intel.com [10.237.68.144]) by linux.intel.com (Postfix) with ESMTP id C9CF65808DF; Thu, 20 Jul 2017 07:11:54 -0700 (PDT) From: Paul Kocialkowski To: intel-gfx@lists.freedesktop.org Date: Thu, 20 Jul 2017 17:11:52 +0300 Message-Id: <20170720141152.15033-1-paul.kocialkowski@linux.intel.com> X-Mailer: git-send-email 2.13.2 Subject: [Intel-gfx] [PATCH i-g-t] docs: Update documentation generation with missing entries 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-Virus-Scanned: ClamAV using ClamSMTP This adds missing entries for documentation generation, both for tests and the API reference. The list of tests is made complete and ordered alphabetically, with modified descriptions for consistency. More files are added to the API reference, with a minimalistic description block added to them when it was missing. Signed-off-by: Paul Kocialkowski Reviewed-by: Arkadiusz Hiler --- docs/reference/intel-gpu-tools/Makefile.am | 24 +++- .../intel-gpu-tools/igt_test_programs.xml | 123 +++++++++++++++++---- .../intel-gpu-tools/intel-gpu-tools-docs.xml | 26 +++-- lib/igt_gvt.c | 7 ++ lib/igt_primes.c | 7 ++ lib/igt_rand.c | 7 ++ lib/igt_x86.c | 7 ++ lib/sw_sync.c | 7 ++ 8 files changed, 174 insertions(+), 34 deletions(-) diff --git a/docs/reference/intel-gpu-tools/Makefile.am b/docs/reference/intel-gpu-tools/Makefile.am index 0152a40e..ee1e900f 100644 --- a/docs/reference/intel-gpu-tools/Makefile.am +++ b/docs/reference/intel-gpu-tools/Makefile.am @@ -134,7 +134,11 @@ 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 \ +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 \ @@ -146,14 +150,28 @@ test_program_files = xml/igt_test_programs_core_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_sysfs_description.xml \ - xml/igt_test_programs_sysfs_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). diff --git a/docs/reference/intel-gpu-tools/igt_test_programs.xml b/docs/reference/intel-gpu-tools/igt_test_programs.xml index 97159df9..ec05d53e 100644 --- a/docs/reference/intel-gpu-tools/igt_test_programs.xml +++ b/docs/reference/intel-gpu-tools/igt_test_programs.xml @@ -100,19 +100,46 @@ + + + AMDGPU Tests + Tests for amdgpu driver behaviour + + + + + + + + Chamelium Tests + Tests using the Chamelium platform + + + + + Core Tests - Tests for core drm ioctls and behaviour. + Tests for core drm ioctls and behaviour + + + Debugfs Tests + Tests for debugfs behaviour + + + + + DRM Tests - Tests for libdrm behaviour. + Tests for libdrm behaviour @@ -121,7 +148,7 @@ DRV Tests - Tests for overall driver behaviour. + Tests for overall driver behaviour @@ -130,21 +157,66 @@ GEM Tests - Tests for core drm ioctls and behaviour. + 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 - Mode setting tests + Tests for kernel mode setting + + + Meta Tests + Tests for the CI system itself + + + + + + + + Perf Tests + Tests for the performance metrics + + + + + PM Tests @@ -157,37 +229,46 @@ Prime Tests - Buffer sharing tests + Tests for buffer sharding - + - Gen 3 Tests - Gen 3 specific tests + SW Sync Tests + Tests for software sync (fencing) - - + + - + - Sysfs Tests - Sysfs tests + Display Tests + Tests for display validation - - + + - + - Debugfs Tests - Debugfs tests + Tools Tests + Tests for IGT tools behaviour - - + + + + + + + vGEM Tests + Tests for the vitual graphics execution manager + + + 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 990bbb80..f88afd2a 100644 --- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml +++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml @@ -16,25 +16,31 @@ API Reference + + - - - - + - + + + + - + + + + + + + - - - - + + diff --git a/lib/igt_gvt.c b/lib/igt_gvt.c index 4ab74332..a78e98e9 100644 --- a/lib/igt_gvt.c +++ b/lib/igt_gvt.c @@ -31,6 +31,13 @@ #include #include +/** + * SECTION:igt_gvt + * @short_description: Graphics virtualization technology library + * @title: GVT + * @include: igt_gvt.h + */ + static bool is_gvt_enabled(void) { bool enabled = false; diff --git a/lib/igt_primes.c b/lib/igt_primes.c index d5232e54..3578a3c6 100644 --- a/lib/igt_primes.c +++ b/lib/igt_primes.c @@ -28,6 +28,13 @@ #include #include +/** + * SECTION:igt_primes + * @short_description: Prime numbers helper library + * @title: Primes + * @include: igt_primes.h + */ + #define BITS_PER_CHAR 8 #define BITS_PER_LONG (sizeof(long)*BITS_PER_CHAR) diff --git a/lib/igt_rand.c b/lib/igt_rand.c index b8d3a92c..664a4764 100644 --- a/lib/igt_rand.c +++ b/lib/igt_rand.c @@ -1,5 +1,12 @@ #include "igt_rand.h" +/** + * SECTION:igt_rand + * @short_description: Random numbers helper library + * @title: Random + * @include: igt_rand.h + */ + static uint32_t global = 0x12345678; uint32_t hars_petruska_f54_1_random_seed(uint32_t new_state) diff --git a/lib/igt_x86.c b/lib/igt_x86.c index f40b9a2f..6f03849f 100644 --- a/lib/igt_x86.c +++ b/lib/igt_x86.c @@ -40,6 +40,13 @@ #include "igt_x86.h" #include +/** + * SECTION:igt_x86 + * @short_description: x86 helper library + * @title: x86 + * @include: igt_x86.h + */ + #define BASIC_CPUID 0x0 #define EXTENDED_CPUID 0x80000000 diff --git a/lib/sw_sync.c b/lib/sw_sync.c index c05a7876..7bd76702 100644 --- a/lib/sw_sync.c +++ b/lib/sw_sync.c @@ -41,6 +41,13 @@ #include "drmtest.h" #include "ioctl_wrappers.h" +/** + * SECTION:sw_sync + * @short_description: Software sync (fencing) support library + * @title: SW Sync + * @include: sw_sync.h + */ + struct int_sync_create_fence_data { __u32 value; char name[32];