Re: [PATCH i-g-t v1] README: Document skip message format

[Jani Nikula <jani.nikula@intel.com>]

On Wed, 01 Apr 2026, Sowmiya S <sowmiya.s@intel.com> wrote:
> 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));
> +```

"SKIP:" comes from the plumbing already, doesn't it? There's no point in
having every igt_skip* call in the codebase add that.

In general, you'd do well to document current usage first, and then
suggest changes. Writing a wishlist documenting what you'd like to see
is not going to make it magically happen.

BR,
Jani.

-- 
Jani Nikula, Intel