[Intel-gfx] [PATCH i-g-t v2 2/6] docs: add some test descriptions

[Thomas Wood]

Signed-off-by: Thomas Wood <thomas.wood at intel.com>
---
 tests/core_getclient.c      |  5 ++---
 tests/core_getstats.c       |  3 +++
 tests/core_getversion.c     |  6 +++---
 tests/kms_3d.c              |  2 ++
 tests/kms_cursor_crc.c      |  8 ++++++++
 tests/kms_fbc_crc.c         |  5 +++++
 tests/kms_fence_pin_leak.c  |  3 +++
 tests/kms_flip_event_leak.c | 12 ++++++------
 8 files changed, 32 insertions(+), 12 deletions(-)

diff --git a/tests/core_getclient.c b/tests/core_getclient.c
index ed46e51..7598e0f 100644
--- a/tests/core_getclient.c
+++ b/tests/core_getclient.c
@@ -32,9 +32,8 @@
 
 #include "drmtest.h"
 
-/**
- * Checks DRM_IOCTL_GET_CLIENT.
- */
+IGT_TEST_DESCRIPTION("Tests the DRM_IOCTL_GET_CLIENT ioctl.");
+
 igt_simple_main
 {
 	int fd, ret;
diff --git a/tests/core_getstats.c b/tests/core_getstats.c
index 1e2c565..52a2d20 100644
--- a/tests/core_getstats.c
+++ b/tests/core_getstats.c
@@ -40,6 +40,9 @@
  * I don't care too much about the actual contents, just that the kernel
  * doesn't crash.
  */
+
+IGT_TEST_DESCRIPTION("Tests the DRM_IOCTL_GET_STATS ioctl.");
+
 igt_simple_main
 {
 	int fd, ret;
diff --git a/tests/core_getversion.c b/tests/core_getversion.c
index 7058c89..30132e4 100644
--- a/tests/core_getversion.c
+++ b/tests/core_getversion.c
@@ -29,9 +29,9 @@
 #include <sys/ioctl.h>
 #include "drmtest.h"
 
-/**
- * Checks DRM_IOCTL_GET_VERSION and libdrm's drmGetVersion() interface to it.
- */
+IGT_TEST_DESCRIPTION("Tests the DRM_IOCTL_GET_VERSION ioctl and libdrm's "
+		     "drmGetVersion() interface to it.");
+
 igt_simple_main
 {
 	int fd;
diff --git a/tests/kms_3d.c b/tests/kms_3d.c
index 4ecb90d..b1712b2 100644
--- a/tests/kms_3d.c
+++ b/tests/kms_3d.c
@@ -27,6 +27,8 @@
 #include "drmtest.h"
 #include "igt_edid.h"
 
+IGT_TEST_DESCRIPTION("Tests 3D mode setting.");
+
 igt_simple_main
 {
 	int drm_fd;
diff --git a/tests/kms_cursor_crc.c b/tests/kms_cursor_crc.c
index 87b4f64..5772ed4 100644
--- a/tests/kms_cursor_crc.c
+++ b/tests/kms_cursor_crc.c
@@ -34,6 +34,14 @@
 #include "intel_chipset.h"
 #include "igt_aux.h"
 
+IGT_TEST_DESCRIPTION(
+   "Use the display CRC support to validate cursor plane functionality. "
+   "The test will position the cursor plane either fully onscreen, "
+   "partially onscreen, or fully offscreen, using either a fully opaque "
+   "or fully transparent surface. In each case it then reads the PF CRC "
+   "and compares it with the CRC value obtained when the cursor plane "
+   "was disabled.");
+
 #ifndef DRM_CAP_CURSOR_WIDTH
 #define DRM_CAP_CURSOR_WIDTH 0x8
 #endif
diff --git a/tests/kms_fbc_crc.c b/tests/kms_fbc_crc.c
index e1e8e97..43e68bd 100644
--- a/tests/kms_fbc_crc.c
+++ b/tests/kms_fbc_crc.c
@@ -34,6 +34,11 @@
 #include "intel_batchbuffer.h"
 #include "ioctl_wrappers.h"
 
+IGT_TEST_DESCRIPTION(
+   "Performs various write operations to the scanout buffer while FBC is "
+   "enabled. CRC checks will be used to make sure the modifications to scanout "
+   "buffer are detected.");
+
 enum test_mode {
 	TEST_PAGE_FLIP,
 	TEST_MMAP_CPU,
diff --git a/tests/kms_fence_pin_leak.c b/tests/kms_fence_pin_leak.c
index 5610ad8..7f530e6 100644
--- a/tests/kms_fence_pin_leak.c
+++ b/tests/kms_fence_pin_leak.c
@@ -35,6 +35,9 @@
 #include "intel_chipset.h"
 #include "igt_aux.h"
 
+IGT_TEST_DESCRIPTION("Exercises full ppgtt fence pin_count leak in the "
+		     "kernel.");
+
 typedef struct {
 	int drm_fd;
 	uint32_t devid;
diff --git a/tests/kms_flip_event_leak.c b/tests/kms_flip_event_leak.c
index 0b45471..8a5e6db 100644
--- a/tests/kms_flip_event_leak.c
+++ b/tests/kms_flip_event_leak.c
@@ -39,12 +39,12 @@ typedef struct {
 	igt_display_t display;
 } data_t;
 
-/*
- * This test tries to provoke the kernel to leak a pending page flip event
- * when the fd is closed before the flip has completed. The test itself won't
- * fail even if the kernel leaks the event, but the resulting dmesg WARN
- * will cause piglit to report a failure.
- */
+IGT_TEST_DESCRIPTION(
+    "This test tries to provoke the kernel into leaking a pending page flip "
+    "event when the fd is closed before the flip has completed. The test "
+    "itself won't fail even if the kernel leaks the event, but the resulting "
+    "dmesg WARN will indicate a failure.");
+
 static bool test(data_t *data, enum pipe pipe, igt_output_t *output)
 {
 	igt_plane_t *primary;
-- 
2.1.0