Skip to content

Commit 105401b

Browse files
committed
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' Fixes: 17acb9f ("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]> Reviewed-by: Sean Paul <[email protected]> Link: https://patchwork.freedesktop.org/patch/msgid/[email protected]
1 parent 86de88c commit 105401b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

include/drm/drm_gem_shmem_helper.h

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,20 @@ struct drm_gem_shmem_object {
4444
*/
4545
unsigned int pages_use_count;
4646

47+
/**
48+
* @madv: State for madvise
49+
*
50+
* 0 is active/inuse.
51+
* A negative value is the object is purged.
52+
* Positive values are driver specific and not used by the helpers.
53+
*/
4754
int madv;
55+
56+
/**
57+
* @madv_list: List entry for madvise tracking
58+
*
59+
* Typically used by drivers to track purgeable objects
60+
*/
4861
struct list_head madv_list;
4962

5063
/**

0 commit comments

Comments
 (0)