From: Sowmiya S <sowmiya.s@intel.com>
To: igt-dev@lists.freedesktop.org
Cc: karthik.b.s@intel.com, swati2.sharma@intel.com,
Sowmiya S <sowmiya.s@intel.com>
Subject: [PATCH i-g-t v2] README: Document skip message format
Date: Mon, 6 Apr 2026 14:38:55 +0530 [thread overview]
Message-ID: <20260406090902.1001161-1-sowmiya.s@intel.com> (raw)
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=y, Size: 2751 bytes --]
KMS tests currently skip in different ways when a machine does not have
the required connectors or display modes. Because every test invents its
own wording, capitalisation and punctuation, automated tools cannot
reliably match skip reasons across tests, making bug filing harder.
provide a consistent style for new and updated KMS tests to follow.
Signed-off-by: Sowmiya S <sowmiya.s@intel.com>
---
README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 52 insertions(+)
diff --git a/README.md b/README.md
index b4b9a37ea..4812ff0a6 100644
--- a/README.md
+++ b/README.md
@@ -188,3 +188,55 @@ Imported non-DRM uapi headers from airlied's drm-next branch.
Then, commit with a note of which exact commit from airlied's branch
was used to generate them.
+
+Skip Messages
+-------------
+
+KMS tests currently skip in many different ways when a machine does not
+have the required connectors or display modes. For example, tests
+checking for a connected output use all of the following today:
+
+```c
+igt_require_f(found, "No valid outputs found\n");
+igt_require_f(found, "No second valid output found\n");
+igt_require_f(first_output, "No display connected to iGPU\n");
+igt_require_f(connector, "No HDMI connector found.\n");
+```
+
+Tests checking for a usable mode or pipe similarly diverge:
+
+```c
+igt_require_f(found, "No valid mode combo found.\n");
+igt_require_f(found, "No valid connector/pipe found\n");
+igt_require_f(found, "No valid pipe/output combo found.\n");
+igt_skip_on_f(!has_supported_mode, "Unsupported mode for all pipes\n");
+```
+
+Different wording, capitalisation and punctuation for the same class of
+skip makes automated bug filing harder — tools cannot reliably match or
+group skip reasons across tests.
+
+For new and updated KMS tests, write skip messages as short,
+human-readable strings, always terminated with `\n`. Include the
+relevant context (connector name, pipe, format, modifier) inline via
+printf-style format specifiers so that logs identify exactly which
+resource was missing:
+
+```c
+/* no connected output */
+igt_require_f(output, "no connected output found\n");
+
+/* no valid connector/pipe combination */
+igt_require_f(found, "no valid connector/pipe combination found\n");
+
+/* no usable mode on a specific output */
+igt_require_f(mode, "no suitable mode found on %s\n", output->name);
+
+/* feature not supported on a specific pipe/format */
+igt_skip_on_f(!igt_display_has_format_mod(display, fmt, modifier),
+ "modifier 0x%llx not supported on pipe %s\n",
+ modifier, kmstest_pipe_name(pipe));
+```
+
+Use the same phrasing for the same class of skip across tests so that
+results can be grouped and tracked reliably.
--
2.48.1
next reply other threads:[~2026-04-06 8:48 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-04-06 9:08 Sowmiya S [this message]
2026-04-06 9:33 ` ✓ Xe.CI.BAT: success for README: Document skip message format (rev2) Patchwork
2026-04-06 9:45 ` ✓ i915.CI.BAT: " Patchwork
2026-04-06 11:58 ` ✓ Xe.CI.FULL: " Patchwork
2026-04-06 13:43 ` ✓ i915.CI.Full: " Patchwork
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260406090902.1001161-1-sowmiya.s@intel.com \
--to=sowmiya.s@intel.com \
--cc=igt-dev@lists.freedesktop.org \
--cc=karthik.b.s@intel.com \
--cc=swati2.sharma@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox