diff mbox series

[v7,1/4] Documentation/gpu: Clarify format of driver-specific fidnfo keys

Message ID 20250108210259.647030-2-adrian.larumbe@collabora.com (mailing list archive)
State New
Headers show
Series drm/panthor: Display size of internal kernel BOs through fdinfo | expand

Commit Message

Adrián Larumbe Jan. 8, 2025, 9:02 p.m. UTC
This change reflects de facto usage by amdgpu, as exemplified by commit
d6530c33a978 ("drm/amdgpu: expose more memory stats in fdinfo").

Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
Cc: Tvrtko Ursulin <tursulin@ursulin.net>
---
 Documentation/gpu/drm-usage-stats.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

Comments

Tvrtko Ursulin Jan. 9, 2025, 12:56 p.m. UTC | #1
On 08/01/2025 21:02, Adrián Larumbe wrote:
> This change reflects de facto usage by amdgpu, as exemplified by commit
> d6530c33a978 ("drm/amdgpu: expose more memory stats in fdinfo").
> 
> Signed-off-by: Adrián Larumbe <adrian.larumbe@collabora.com>
> Cc: Tvrtko Ursulin <tursulin@ursulin.net>
> ---
>   Documentation/gpu/drm-usage-stats.rst | 5 ++++-
>   1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/gpu/drm-usage-stats.rst b/Documentation/gpu/drm-usage-stats.rst
> index 2717cb2a597e..2b5393ed7692 100644
> --- a/Documentation/gpu/drm-usage-stats.rst
> +++ b/Documentation/gpu/drm-usage-stats.rst
> @@ -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.

LGTM, thanks for documenting it!

Acked-by: Tvrtko Ursulin <tvrtko.ursulin@igalia.com>

Native english speaker maybe could clarify if s/Driver-specific/Driver 
specific/ would be more correct.

Regards,

Tvrtko
diff mbox series

Patch

diff --git a/Documentation/gpu/drm-usage-stats.rst b/Documentation/gpu/drm-usage-stats.rst
index 2717cb2a597e..2b5393ed7692 100644
--- a/Documentation/gpu/drm-usage-stats.rst
+++ b/Documentation/gpu/drm-usage-stats.rst
@@ -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.