public inbox for igt-dev@lists.freedesktop.org
 help / color / mirror / Atom feed
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 v1] README: Document skip message format
Date: Wed,  1 Apr 2026 10:03:01 +0530	[thread overview]
Message-ID: <20260401043317.890733-1-sowmiya.s@intel.com> (raw)

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=y, Size: 2066 bytes --]

Add a concise guide for writing consistent, machine-friendly skip
messages in IGT tests. Defines the format:

  SKIP: <reason> [(<context_type>: <value>)]

along with common context types, example messages and a code snippet.

Signed-off-by: Sowmiya S <sowmiya.s@intel.com>
---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/README.md b/README.md
index b4b9a37ea..a652cc0d1 100644
--- a/README.md
+++ b/README.md
@@ -188,3 +188,40 @@ 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 Message Format
+-------------------
+
+Keep skip messages consistent and machine-friendly. Use this concise
+format and include a single, most-relevant context when available:
+
+- Format: `SKIP: <reason> [(<context_type>: <value>)]` (always end with `\n`)
+- Rules: start with `SKIP:`, use a short lowercase `reason`, include at
+    most one `context` in parentheses, use `0x%llx` for modifiers, and
+    do not add a trailing period.
+
+### `Common context types and examples:`
+
+- `connector`: display connector name — `(connector: HDMI-A-1)`
+- `plane`: plane type — `(plane: primary)`
+- `format`: fourcc format — `(format: NV12)`
+- `modifier`: buffer modifier (hex) — `(modifier: 0x%llx)`
+- `pipe`: pipe id/name — `(pipe: A)`
+- `platform`: GPU/platform name — `(platform: i915)`
+
+### `Common concise messages:`
+
+- `SKIP: no suitable connector available`
+- `SKIP: connector is disconnected (connector: %s)`
+- `SKIP: no suitable display mode available (connector: %s)`
+- `SKIP: format not supported (plane: %s, format: %s)`
+- `SKIP: modifier not supported (modifier: 0x%llx)`
+- `SKIP: plane not available (plane: %s)`
+
+### `Example usage:`
+
+```c
+        igt_skip_on_f(!fmt_supported(plane, fmt),
+                            "SKIP: format not supported (plane: %s, format: %s)\n",
+                            igt_plane_name(plane), igt_format_str(fmt));
+```
-- 
2.43.0


             reply	other threads:[~2026-04-01  4:12 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-01  4:33 Sowmiya S [this message]
2026-04-01  4:51 ` ✓ Xe.CI.BAT: success for README: Document skip message format Patchwork
2026-04-01  5:02 ` ✓ i915.CI.BAT: " Patchwork
2026-04-01 11:26 ` ✓ Xe.CI.FULL: " Patchwork
2026-04-01 21:17 ` ✗ i915.CI.Full: failure " Patchwork
2026-04-02  9:59 ` [PATCH i-g-t v1] " Kamil Konieczny
2026-04-06  8:07   ` S, Sowmiya
2026-04-02 12:51 ` Jani Nikula
2026-04-06  7:58   ` S, Sowmiya

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=20260401043317.890733-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