drm/shmem: Add docbook comments for drm_gem_shmem_object madvise fields
Subsystems (2)
PATCH 1/1 drm/shmem: Add docbook comments for drm_gem_shmem_object madvise fields
Add missing docbook comments to madvise fields in struct drm_gem_shmem_object which fixes these warnings:
include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv' not described in 'drm_gem_shmem_object' include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv_list' not described in 'drm_gem_shmem_object'
--- include/drm/drm_gem_shmem_helper.h | 13 +++++++++++++ 1 file changed, 13 insertions(+)
include/drm/drm_gem_shmem_helper.h +13 -0
@@ -44,7 +44,20 @@ struct drm_gem_shmem_object {*/ unsigned int pages_use_count; +/** +* @madv: State for madvise +* +* 0 is active/inuse. +* A negative value is the object is purged. +* Positive values are driver specific and not used by the helpers. +*/ int madv; + +/** +* @madv_list: List entry for madvise tracking +* +* Typically used by drivers to track purgeable objects +*/ struct list_head madv_list;/**
Signature · 6 lines
2.20.1 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Quoted 6 lines · Rob Herring
Add missing docbook comments to madvise fields in struct
drm_gem_shmem_objectwhich fixes these warnings:
include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv' not described in 'drm_gem_shmem_object'include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv_list' not described in 'drm_gem_shmem_object'
Quoted 6 lines
Fixes 17acb9f35ed7 ("drm/shmem: Add madvise state and purge helpers")Reported-by Sean Paul <[email protected]>Cc Maarten Lankhorst <[email protected]>Cc Maxime Ripard <[email protected]>Cc David Airlie <[email protected]>Cc Daniel Vetter <[email protected]>
Quoted 33 lines
Signed-off-by Rob Herring <[email protected]>--- include/drm/drm_gem_shmem_helper.h | 13 +++++++++++++ 1 file changed, 13 insertions(+)include/drm/drm_gem_shmem_helper.h +13
-0@@ -44,7 +44,20 @@ struct drm_gem_shmem_object {*/ unsigned int pages_use_count; +/** +* @madv: State for madvise +* +* 0 is active/inuse. +* A negative value is the object is purged. +* Positive values are driver specific and not used by the helpers. +*/ int madv; + +/** +* @madv_list: List entry for madvise tracking +* +* Typically used by drivers to track purgeable objects +*/ struct list_head madv_list;/** Signature · 1 line
2.20.1
Signature · 5 lines
Sean Paul, Software Engineer, Google / Chromium OS _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
Quoted 7 lines · Rob Herring
Add missing docbook comments to madvise fields in struct
drm_gem_shmem_objectwhich fixes these warnings:
include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv' not described in 'drm_gem_shmem_object'include/drm/drm_gem_shmem_helper.h:87: warning: Function parameter or member 'madv_list' not described in 'drm_gem_shmem_object'
Quoted 7 lines
Fixes 17acb9f35ed7 ("drm/shmem: Add madvise state and purge helpers")Reported-by Sean Paul <[email protected]>Cc Maarten Lankhorst <[email protected]>Cc Maxime Ripard <[email protected]>Cc David Airlie <[email protected]>Cc Daniel Vetter <[email protected]>Signed-off-by Rob Herring <[email protected]>
Kerneldoc for the functions you've added in 17acb9f35ed7 ("drm/shmem:
Add madvise state and purge helpers") is also missing. Can you pls fix that too?
Thanks, Daniel
Quoted 32 lines
--- include/drm/drm_gem_shmem_helper.h | 13 +++++++++++++ 1 file changed, 13 insertions(+)include/drm/drm_gem_shmem_helper.h +13
-1@@ -44,7 +44,20 @@ struct drm_gem_shmem_object {*/ unsigned int pages_use_count; +/** +* @madv: State for madvise +* +* 0 is active/inuse. +* A negative value is the object is purged. +* Positive values are driver specific and not used by the helpers. +*/ int madv; + +/** +* @madv_list: List entry for madvise tracking +* +* Typically used by drivers to track purgeable objects +*/ struct list_head madv_list;/** -- 2.20.1
Signature · 7 lines
Daniel Vetter Software Engineer, Intel Corporation +41 (0) 79 365 57 48 - http://blog.ffwll.ch _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel