Commit 3ddf003c authored by Adrián Larumbe's avatar Adrián Larumbe Committed by Boris Brezillon
Browse files

Documentation/gpu: Clarify format of driver-specific fidnfo keys 



This change reflects de facto usage by amdgpu, as exemplified by commit
d6530c33 ("drm/amdgpu: expose more memory stats in fdinfo").

Cc: Tvrtko Ursulin <tursulin@ursulin.net>
Acked-by: default avatarTvrtko Ursulin <tvrtko.ursulin@igalia.com>
Signed-off-by: default avatarAdrián Larumbe <adrian.larumbe@collabora.com>
Signed-off-by: default avatarBoris Brezillon <boris.brezillon@collabora.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20250130172851.941597-2-adrian.larumbe@collabora.com
parent 2eca617f

Documentation/gpu/drm-usage-stats.rst

+4 −1
Original line number Diff line number Diff line
@@ -21,7 +21,10 @@ File format specification 


- File shall contain one key value pair per one line of text.

- Colon character (`:`) must be used to delimit keys and values.

- All keys shall be prefixed with `drm-`.

- All standardised keys shall be prefixed with `drm-`.

- Driver-specific keys shall be prefixed with `driver_name-`, where

  driver_name should ideally be the same as the `name` field in

  `struct drm_driver`, although this is not mandatory.

- Whitespace between the delimiter and first non-whitespace character shall be

  ignored when parsing.

- Keys are not allowed to contain whitespace characters.